- AGENTS.md ทำหน้าที่เสริม README และเป็น ไฟล์เฉพาะที่เก็บบริบทและคำแนะนำ ที่เอเจนต์เขียนโค้ด AI ต้องใช้เมื่อลงมือทำงานในโปรเจกต์
- ขณะนี้มีการใช้งานใน โปรเจกต์โอเพนซอร์สมากกว่า 20,000 โปรเจกต์ เพื่อจัดระเบียบข้อมูลอย่างการ build/test/code style ที่ไม่จำเป็นสำหรับมนุษย์ แต่สำคัญสำหรับเอเจนต์
- ให้คำแนะนำสำหรับเอเจนต์ไว้ใน ตำแหน่งที่ชัดเจนและคาดเดาได้ ช่วยให้ README กระชับ ขณะเดียวกันก็เพิ่มประสิทธิภาพการทำงานร่วมกัน
- AGENTS.md ไฟล์เดียวรองรับเอเจนต์และเครื่องมือได้หลากหลาย และในโมโนรีโปขนาดใหญ่ก็สามารถใช้ AGENTS.md แยกตามแต่ละซับโปรเจกต์ ได้
- เป็น มาตรฐานแบบเปิด ที่เกิดจากความร่วมมือของหลายอีโคซิสเต็ม เช่น OpenAI Codex, Cursor, Google Jules
Why AGENTS.md?
- README.md เป็นเอกสารสำหรับมนุษย์ ใช้สำหรับ quick start, คำอธิบายโปรเจกต์ และแนวทางการมีส่วนร่วม
- AGENTS.md เป็นเอกสารเสริมสำหรับเอเจนต์ ที่เก็บบริบทเชิงรายละเอียดอย่างกฎ build/test/code เพื่อไม่ให้ README ซับซ้อนเกินไป
- เหตุผลที่แยกเป็นไฟล์ต่างหาก
- ให้ ตำแหน่งคำแนะนำที่คาดเดาได้ สำหรับสิ่งที่เอเจนต์ต้องอ้างอิง
- ทำให้ README ยังคงกระชับโดยยึดมนุษย์ผู้ร่วมพัฒนาเป็นศูนย์กลาง
- ให้ คำแนะนำเฉพาะสำหรับเอเจนต์ที่มีความละเอียดสูง และช่วยเสริมเอกสารเดิม
- เลือกใช้ชื่อที่เป็น มาตรฐานแบบเปิดที่ใครก็ใช้ได้ ไม่ใช่ฟอร์แมตแบบปิดของผู้ให้บริการใดผู้ให้บริการหนึ่ง
- AGENTS.md เดียว สามารถใช้งานร่วมกับเอเจนต์เขียนโค้ด AI และเครื่องมือหลายตัวได้
How to use AGENTS.md?
- 1. สร้างไฟล์ AGENTS.md
- วางไว้ที่รูตของรีโพซิทอรี (เอเจนต์หลายตัวรองรับการสร้างให้อัตโนมัติ)
- 2. เขียนหัวข้อสำคัญ
- ภาพรวมของโปรเจกต์
- คำสั่ง build และ test
- แนวทาง code style
- วิธีการทดสอบ
- ข้อพิจารณาด้านความปลอดภัย
- 3. ใส่คำแนะนำเพิ่มเติม
- สิ่งที่ต้องการสื่อสารกับสมาชิกทีม เช่น กฎ commit/PR, ข้อควรระวังด้านความปลอดภัย, ชุดข้อมูลขนาดใหญ่, ขั้นตอนการ deploy
- 4. รองรับโมโนรีโป
- สามารถวาง AGENTS.md แยกตามแต่ละแพ็กเกจได้
- เอเจนต์จะอ่าน ไฟล์ที่อยู่ใกล้ที่สุด และปฏิบัติตามคำแนะนำที่เหมาะกับซับโปรเจกต์นั้น
- ตัวอย่าง: รีโพซิทอรีของ OpenAI มี AGENTS.md อยู่ 88 ไฟล์
FAQ
- รายการที่จำเป็น: ไม่มี สามารถใช้รูปแบบ Markdown ทั่วไปได้อย่างอิสระ
- เมื่อเกิดความขัดแย้ง: AGENTS.md ที่ใกล้ที่สุดมีลำดับความสำคัญก่อน และพรอมป์ต์ที่ผู้ใช้ระบุไว้อย่างชัดเจนจะถูกใช้เป็นลำดับสุดท้าย
- มีการรันอัตโนมัติหรือไม่: เอเจนต์สามารถรันคำสั่งทดสอบที่ระบุไว้ในไฟล์เพื่อพยายามแก้ไขข้อผิดพลาดได้
- อัปเดตได้หรือไม่: เปลี่ยนแปลงได้ตลอดเวลา และควรดูแลในฐานะ เอกสารที่มีชีวิต
- การย้ายจากเอกสารเดิม: เปลี่ยนชื่อไฟล์แล้วคงความเข้ากันได้ด้วย symbolic link
mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md
ยังไม่มีความคิดเห็น