ปรับแต่ง Gemini โดยใช้ไฟล์ AGENTS.md

ให้คำสั่งที่ปรับแต่งแล้วแก่ Gemini ใน Android Studio เพื่อทำตามโดยใช้ไฟล์อย่างน้อย 1 ไฟล์AGENTS.md AGENTS.md จะอยู่ในโฟลเดอร์เดียวกับไฟล์อื่นๆ ใน ฐานของโค้ดของคุณ คุณจึงสามารถเช็คอินไฟล์ไปยังระบบควบคุมเวอร์ชัน (VCS) และแชร์คำสั่งเฉพาะโปรเจ็กต์ กฎรูปแบบการเขียนโค้ด และ คำแนะนำอื่นๆ กับทั้งทีมได้อย่างง่ายดาย

หากต้องการเริ่มต้นใช้งาน ให้ทำตามขั้นตอนต่อไปนี้

  1. สร้างไฟล์ AGENTS.md ที่ใดก็ได้ในระบบไฟล์ของโปรเจ็กต์ Gemini จะสแกนไดเรกทอรีปัจจุบันและไดเรกทอรีหลักทั้งหมดเพื่อหาไฟล์ AGENTS.md เมื่อคุณส่งคำค้นหา ดูรายละเอียดเพิ่มเติมได้ที่หัวข้อวิธีการทำงานของไฟล์ AGENTS.md

  2. เพิ่มคำสั่ง เขียนวิธีการโดยใช้มาร์กดาวน์ เพื่อให้อ่านง่าย ลองใช้หัวเรื่องและหัวข้อย่อยสำหรับกฎต่างๆ ดูวิธีการตัวอย่าง

  3. บันทึกและคอมมิตไฟล์ไปยัง VCS เพื่อแชร์กับทีม

จัดการAGENTS.mdเป็นบริบท

คุณสามารถใช้หรือนำไฟล์ AGENTS.md ออกเพื่อเป็นบริบทสำหรับคำค้นหาหนึ่งๆ โดยใช้ลิ้นชักบริบทในแผงแชท ตัวเลือกAGENTS.md ไฟล์ รวมถึงAGENTS.mdไฟล์ทั้งหมดในไดเรกทอรีปัจจุบันและไดเรกทอรี ระดับบน

จัดการไฟล์ AGENTS.md เป็นบริบท
รูปที่ 1 จัดการAGENTS.mdไฟล์เป็นบริบท

ตัวอย่างวิธีการ

คุณใช้ไฟล์ AGENTS.md เพื่อให้คำสั่งแก่ตัวแทนได้ ตัวอย่างต่อไปนี้เป็นเพียงตัวอย่างบางส่วน แต่คำสั่งที่คุณระบุควรเฉพาะเจาะจงสำหรับโปรเจ็กต์ของคุณ

  • "กิจกรรมหลักคือ /path/to/MainActivity.kt"
  • "โค้ดที่รองรับการไปยังส่วนต่างๆ ระหว่างหน้าจอคือ path/to/navigation/UiNavigation.kt"
  • "โค้ดที่จัดการคำขอ HTTP อยู่ที่ <path>"
  • สถาปัตยกรรมของโปรเจ็กต์
    • "วางตรรกะทางธุรกิจทั้งหมดไว้ใน ViewModel"
    • "ปฏิบัติตามคำแนะนำด้านสถาปัตยกรรมอย่างเป็นทางการเสมอ รวมถึงการใช้ สถาปัตยกรรมแบบเลเยอร์ ใช้โฟลว์ข้อมูลแบบทิศทางเดียว (UDF), ViewModels, การรวบรวมสถานะ UI ที่รับรู้ถึงวงจร และคำแนะนำอื่นๆ
  • ห้องสมุดที่ต้องการ: "ใช้ห้องสมุด <ชื่อห้องสมุด> สำหรับการนำทาง"
  • การกำหนดชื่อตัวยึดตำแหน่งสำหรับบริการ API ทั่วไปหรือคำศัพท์ภายใน "บริการแบ็กเอนด์หลักเรียกว่า "PhotoSift-API""
  • คู่มือสไตล์ของบริษัท: "คอมโพเนนต์ UI ใหม่ทั้งหมดต้องสร้างด้วย Jetpack Compose อย่าแนะนำเลย์เอาต์ที่อิงตาม XML"

แยกส่วนไฟล์ AGENTS.md

คุณสามารถแบ่งAGENTS.mdไฟล์ขนาดใหญ่ออกเป็นไฟล์ขนาดเล็กที่นำกลับมาใช้ใหม่ได้ ในบริบทต่างๆ ดังนี้

  1. แยกชุดคำสั่งออกมาและบันทึกไว้ในไฟล์มาร์กดาวน์อีกไฟล์หนึ่ง เช่น style-guidance.md

  2. อ้างอิงไฟล์มาร์กดาวน์ที่มีขนาดเล็กลงในไฟล์ AGENTS.md โดยใช้สัญลักษณ์ @ ตามด้วยเส้นทางไปยังไฟล์ที่ต้องการนำเข้า ระบบรองรับรูปแบบเส้นทางต่อไปนี้

    • เส้นทางแบบสัมพัทธ์
      • @./file.md - นำเข้าจากไดเรกทอรีเดียวกัน
      • @../file.md - นำเข้าจากไดเรกทอรีระดับบน
      • @./subdirectory/file.md - นำเข้าจากไดเรกทอรีย่อย
    • เส้นทางแบบสัมบูรณ์: @/absolute/path/to/file.md

ตัวอย่างเช่น AGENTS.md ไฟล์ต่อไปนี้อ้างอิงไฟล์คำสั่งอื่นๆ อีก 2 ไฟล์

# My AGENTS.md

You are an experienced Android app developer.

@./get-started.md

## Coding style

@./shared/style-guidance.md

วิธีการทำงานของไฟล์ AGENTS.md

Gemini จะสแกนไดเรกทอรีปัจจุบันและไดเรกทอรีระดับบนโดยอัตโนมัติเพื่อหาไฟล์ AGENTS.md และเพิ่มเนื้อหาของไฟล์เหล่านั้นไว้ที่จุดเริ่มต้นของทุกพรอมต์เป็นข้อความนำ หากคุณไม่ได้เปิดไฟล์เมื่อส่งคำค้นหา ระบบจะรวมไฟล์ AGENTS.md ที่รูทของโปรเจ็กต์ (หากมี) ไว้ด้วยโดยค่าเริ่มต้น

ไฟล์ AGENTS.md และกฎแตกต่างกันอย่างไร

กฎยังช่วยให้คุณกำหนดวิธีการและความชอบ ที่มีผลกับพรอมต์ทั้งหมดได้ด้วย อย่างไรก็ตาม กฎจะกำหนดไว้ในไฟล์ IntelliJ /.idea/project.prompts.xml ส่วนไฟล์ AGENTS.md จะบันทึกไว้ข้างๆ ซอร์สโค้ดและไม่ขึ้นอยู่กับ IDE เราขอแนะนำให้ใช้ไฟล์ AGENTS.md หากมีวัตถุประสงค์หลักอย่างใดอย่างหนึ่งต่อไปนี้ คือการแชร์วิธีการกับทีม

ไฟล์ AGENTS.md กับทักษะแตกต่างกันอย่างไร

ทักษะแสดงถึงความเชี่ยวชาญแบบออนดีมานด์ที่จะเรียกใช้เมื่อคำขอของคุณตรงกับคำอธิบายทักษะ ส่วนเนื้อหาใน AGENTS.md จะเพิ่มที่จุดเริ่มต้นของพรอมต์ทุกรายการ เราขอแนะนำให้ใช้ทักษะสำหรับงานที่เฉพาะเจาะจงและใช้ไฟล์ AGENTS.md เพื่อกำหนดลักษณะการทำงานทั่วไปของเอเจนต์ ดูข้อมูลเพิ่มเติมเกี่ยวกับทักษะได้ที่ข้อมูลเบื้องต้นเกี่ยวกับทักษะ Android