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

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

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

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

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

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

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

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

ตัวอย่างคำแนะนำ

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

• "กิจกรรมหลักคือ /path/to/MainActivity.kt"
• "โค้ดที่รองรับการไปยังส่วนต่างๆ ระหว่างหน้าจอคือ path/to/navigation/UiNavigation.kt"
• โค้ดที่จัดการคำขอ HTTP อยู่ที่ <path>
• สถาปัตยกรรมของโปรเจ็กต์
  • "วางตรรกะทางธุรกิจทั้งหมดไว้ใน ViewModel"
  • "ปฏิบัติตามคำแนะนำสถาปัตยกรรมอย่างเป็นทางการเสมอ รวมถึงการใช้สถาปัตยกรรมแบบเลเยอร์ ใช้โฟลว์ข้อมูลแบบทิศทางเดียว (UDF), ViewModel, การรวบรวมสถานะ 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 {:#coding-style}

@./shared/style-guidance.md

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

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

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

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

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

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