AGENTS.md 怎麼寫:留下項目約束,再用索引組織細節
「保持樣式」「別加後端」「改完跑測試」反覆說了幾次,就值得寫進項目說明。AGENTS.md 適合留下長期有效的約束,下一次接手項目時更容易找回這些要求。
檔案不用長,先把項目範圍、修改邊界和檢查方法寫明白。
一個小項目可以從這份說明開始
下面是待辦項目的模板,路徑和指令要按實際項目調整:
# 項目說明
- 原生 HTML/CSS/JavaScript;儲存版位於 demo/after/。
- 保持頁面樣式和無障礙名稱,不新增後端。
- demo/before/ 是教學對照,不要把它改成儲存版。
- 首次安裝依賴使用 npm ci。
- 修改 JavaScript 或測試後執行 npm test。
- 驗收覆蓋新增後刷新、刪除後刷新、空白輸入和壞 JSON。
- 交付說明修改內容、實際執行的檢查及未驗證部分。
它比「寫高品質程式碼」更容易執行:能找到目錄、能執行指令,也能判斷哪些行為不能改。
檔案放在哪裏
項目專用說明放在項目根目錄。個人通用偏好可以放在 Codex 的全局說明中,預設目錄是 ~/.codex。不要把某個項目的專屬腳本寫成所有項目都必須執行的指令。
官方說明中,Codex 在啟動時構建指令鏈:先看全局,再從項目根目錄走到當前工作目錄;同一目錄下 AGENTS.override.md 優先於 AGENTS.md。檔案改變後,用新的執行或重開會話確認載入情況。官方 AGENTS.md 指南
可以先發一句檢查用的任務:
列出實際讀取的指令檔案,概括本項目的範圍、修改約束和驗收指令。
先不要改程式碼;無法確認的地方明確說明。
這是提問模板,不是一次真實模型回覆的截圖或記錄。
長起來以後,讓它做索引
規則和操作細節越積越多時,可以在 AGENTS.md 中只留下入口與關鍵約束,詳細方法放進 TASK.md 或項目文件,並明確要求先讀。例如:
開始任務前先讀 TASK.md,瞭解當前狀態和已驗證的方法。
發佈與恢復步驟見 TASK.md;證據儲存在 audits/。
TASK.md 在這裏是項目約定,不是因為這個名字就會自動載入。檔案裏的指令也不能代替程式碼審查和測試輸出。
原筆記發表於2026年10月5日,原稿於10月27日整理並補充索引用法。原項目沿用已有測試,本篇新增的是說明模板,沒有做模型遵守率或指令載入效果的對照實驗。
香港繁體版整理日期:2026年10月28日。原文引用的產品說明核對截至2026年10月27日;原實驗日期與範圍保留於文中。