AGENTS.md 是專案給 AI 助理的常駐工作守則。當你開啟 Codex 對話時,它會自動讀取該檔案中的規範,省去每次手動重複貼上「請勿修改原檔」、「輸出至 outputs/」、「不確定時標記 needs_review」等指令。


1. AGENTS.md 的層級與載入順序

Codex 會依照由上至下的順序載入並串接各層級的指引:

  1. Global(全域):位於 ~/.codex/AGENTS.md,適用於你在該電腦上的所有專案(例如:慣用繁體中文、程式排版風格)。
  2. Project(專案根目錄):位於專案根目錄,定義專案架構、資料保護與研究基本原則。
  3. Nested(子目錄):位於特定子資料夾(如 transcripts/AGENTS.md),僅對該目錄下的任務提供更細緻的覆寫或補充。

Override 機制:若目錄中存在 AGENTS.override.md,Codex 會直接使用它並忽略同目錄的 AGENTS.md,適合短期實驗或特殊任務。


2. 研究專案根目錄範本

可直接放置於專案根目錄的 AGENTS.md

# 研究專案工作規則

## 資料夾用途
- `codebook.md`:質性編碼定義,未經指示不得修改。
- `search-protocol.md`:文獻篩選協議。
- `sources/raw/``transcripts/raw/`:原始資料,**絕對禁止修改或刪除**
- `transcripts/anonymized/`:已去識別化逐字稿,僅供讀取分析。
- `outputs/`:主要分析與結構化輸出檔案。
- `review/`:低信心與需人工判斷的項目。

## 資料安全與研究誠信
- 輸出中僅使用受訪者代碼(如 P01),嚴禁包含姓名、學號或電子郵件。
- 嚴禁自行捏造 DOI、作者、統計數值或引文。
- 無法確認或證據不足之欄位,一律填寫 `needs_review`,不可自行推論。

## 執行與回報原則
- 複雜任務先提出執行步驟,經確認後再處理整批資料。
- 質性編碼嚴格依照 `codebook.md`,新現象寫入 `review/candidate-codes.csv`
- 任務完成後需回報:處理檔案數、產出檔案路徑、缺漏欄位數與待審核清單。

3. 子目錄專屬規則範例

transcripts/AGENTS.md(訪談專屬)

# 訪談資料規則
- 只讀取 `anonymized/` 資料,忽略 `raw/`
- 引文(`verbatim_quote`)必須逐字擷取自文本,不得修飾。
- 允許一文多標籤,輸出採長格式。

literature/AGENTS.md(文獻專屬)

# 文獻資料規則
- 每筆文獻必須包含 DOI 或原始 URL。
- 初篩(題名/摘要)與全文分析分開執行。

4. 該寫什麼與不該寫什麼

適合寫入 不適合寫入
專案目錄結構與讀寫權限 僅適用單一次對話的臨時指令
不變的格式定義(如 CSV 欄位) 密碼、API Key 或未去識別化之個資
去識別化與資料保護規則 冗長空泛的背景描述或研究方法教科書
模糊案例的處理機制 (needs_review) 互相衝突或過度複雜的層疊規則

5. 驗證與常見排查

驗證 Codex 是否已讀取規則

在新對話中輸入:

請先不要修改任何檔案,簡要列出你目前載入的專案工作規則與原始資料保護限制。

常見問題排查

  • 規則未生效:確認檔名是否為精確的 AGENTS.md(注意大小寫),並確認工作目錄位於專案內。
  • 檔案過大被截斷:Codex 預設讀取上限約 32 KiB(project_doc_max_bytes)。請保持條文精簡,將特定規則拆分至子目錄。
  • 使用自訂檔名:若團隊習慣使用其他檔名,需在 .codex/config.toml 中設定 project_doc_fallback_filenames

下一篇將介紹 GPT-5.6 的模型分級(Sol / Terra / Luna)與推理強度(effort)的選擇策略。

參考資料

3 筆
  1. Custom instructions with AGENTS.mdOpenAI 對 AGENTS.md 的發現順序、全域規則、專案規則與覆寫方式的官方說明。
  2. Advanced Configuration說明 project_doc_max_bytes、project_doc_fallback_filenames 與專案設定等進階選項。
  3. Codex Best PracticesCodex 官方對長期工作流程、可重複指引、權限與驗證的建議。