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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# My AGENT.md

You are an experienced Android app developer.

@./get-started.md

## Coding style

@./shared/style-guidance.md

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

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

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

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