文件標準
讓每個頁面都可搜尋、可被新進人員閱讀,且對代理和維護者來說足夠精確。分層級、撰寫規則、篇幅預算和草率清單都存放在 docs/AGENTS.md 中;此技能掌管應用它們的工作流程。為每個事實保留單一擁有者:原始碼、測試、產生的目錄、README、指南和代理筆記各自保存其本身的真實性。這是指導方針,不是核對清單。
工作流程
針對每個要求的範圍,依序執行以下步驟。保持常見讀者路徑簡潔,但不要為了減少字數而刪除失敗案例、所有權、限制或其他必要的約定。
- 讀取根目錄和子目錄的
AGENTS.md檔案、docs/AGENTS.md、目標頁面、其原始碼和測試,以及其導航擁有者。 - 根據一個主要任務和讀者分類頁面:快速入門、使用者任務指南、貢獻者教學、架構概觀、模組參考、產生的參考、代理指令、決策記錄或草稿。
- 將頁面放置在最近的擁有者處。將模組合約保留在模組程式碼旁;跨模組的學習、使用者、開發者和架構材料則使用
docs/。 - 在開始撰寫細節之前,先定義讀者的起始狀態、可觀察到的結果、可能的失敗、復原路徑以及下一個有用的深度。
- 按照頁面結構指定的順序撰寫:標題、摘要、目錄、使用者面向內容、開發者面向內容、選擇性的「進一步探索」。
- 當設定檔啟用
surfaces.bilingual-docs時,在同一個處理階段更新對應版本,並保持標題、清單、表格、程式碼和連結逐行對齊。 - 根據程式碼、測試、產生器、套件中繼資料或當前的決策擁有者驗證每個聲明,並執行頁面指示的操作(參見下方的事實查核程序)。在任何衍生產出之前更新其擁有者。
- 執行設定檔中的
commands.docs-check和git diff --check,然後重新閱讀完整的差異一次以檢查正確性,再一次以檢查簡潔性和適合度。
事實查核程序:測試,不要假設
文件描述產品當前的行為,而操作聲明唯一可接受的證據是實際執行過它。這適用於每個新頁面和每個聲明命令、預設值、錯誤、輸出或平台差異的新段落。
- 在撰寫安裝或使用指導之前,先對主題進行分類。 讀取事實(清單、入口點、匯出),而不是資料夾名稱。函式庫、外掛程式、CLI 和服務各有不同的使用路徑;切勿複製為另一種型別撰寫的指導。
- 對目前的檢出執行每個聲稱的操作。 完全按照頁面將要顯示的方式執行每個命令、設定片段和範例;只記錄你觀察到的內容,包括警告和失敗模式。如果某個聲明依賴於你沒有的憑證或網路,請說明情況並指出驗證擁有者,而不是斷言行爲。
- 刪除你無法重現的內容。 永遠不要從記憶、類比或相鄰的 README 中帶入命令、欄位、預設值或行為。當某個聲明無法重現時,修正聲明,而不是修正測試。
- 根據最新的預設分支檢查舊文件。 在修改現有頁面之前,先擷取並與預設分支進行比較;根據程式碼修正過時的陳述,而不是根據舊的散文。
語調規則
- 摘要說明主題的功能。 摘要和使用者面向區段描述讀者可以用該主題做什麼(成果、何時選擇它、主要成本),絕不描述其內部身份或註冊資訊。除非讀者直接在設定、命令或公開 API 中使用,否則省略原始碼識別碼。
- 開發者區段解釋,絕不列舉。 開發者細節涵蓋設計概念、架構和大致的資料流程,足以了解其運作方式,並連結到程式碼以獲取確切細節。不包含完整的 API 目錄、欄位清單或 API 文件重申。
- 僅描述當前狀態。 一般文件描述當前的程式碼庫;歷史屬於代理筆記、事後檢討、發行說明和升級指南。
- 受控的技術英文。 當歧義可能改變行為時,為每個句子指定一個明確的行動者和一個主要動作;每個概念重複使用一個詞彙;拆分疊加的指令;保留語氣和例外。參見頁面結構。
品質標準
- 簡潔: 常見路徑只包含其成果所需的事實;詳盡的事實距離一個連結或細節層之遙。
- 直覺: 先決條件先於依賴概念,一個下一步操作顯而易見,標題使用讀者會搜尋的詞彙。
- 友善: 讀者能辨識成功、在行動前了解風險、從可能的失敗中復原,並選擇是否要深入探討。
- 精確: 每個持久的聲明都有一個擁有者,以及與其風險成比例的驗證路徑。
- 代理可讀: 穩定的標題、錨點、詞彙和所有權支援有目標的檢索,而無需載入整個語料庫。
- 新進人員完整: 沒有儲存庫背景的工程師可以透過三到五個連結的頁面,重建相關的架構或功能。
不要對詳盡的參考文件套用普適的字數限制;應衡量入口路徑長度、每次查閱掃描到的無關材料量以及最大的區段,並在檢索成本高時,由現有的領域擁有者進行拆分。
稽核語料庫
將 docs/AGENTS.md 中的寫作順序應用於範圍內的每個人類面向文件(而非代理筆記):定位文件並說明其主題;設定其允許的細節,並將更深層的解釋移至擁有的下層文件;根據預期用途(而非路徑)分類為教學或參考;拆分大量混合形式。移動是原子性的,所有入站連結必須在同一變更中修復;從不手動編輯產生的目錄。
然後檢查 docs/AGENTS.md 中的草率清單,優先使用最便宜的檢測方式:使用 trim-cot-leakage 來處理推理鏈路洩漏;搜尋獨特詞組以找出重複的規則;以權威擁有者取代手寫的目錄;從已實作的代理筆記中移除規格語言。如果移除散文會改變承諾的行為(而非其解釋),請先提出行為變更(參見 find-simplifications)。保留每個承載規則的規則,最好以一至三行加上其理由的連結呈現。
詳細參考資料
使用 prose-standard 來處理句子層級的合約覆蓋範圍和編輯判斷。