$docdiet
僅當使用者明確要求文件審查、清理或更新(通常透過呼叫 $docdiet)時,才使用此技能。這是一個獨立、按需的審查/更新技能,而非自動的每項任務鉤子。僅審查或更新使用者指定的或請求變更所明確暴露的文件範圍;請勿啟動不相關的審計。
明確請求如 $docdiet all docs 或 $docdiet project-wide 可授權進行有範圍限制的專案級別處理。在該模式下,範圍僅限於儲存庫根目錄下包含 .md、.mdx、.rst 或 .adoc 副檔名的文件,以及根層級的 README* 和 CONTRIBUTING* 檔案。請排除生成或供應商目錄和檔案、變更日誌/發行說明、授權或法律資料、行為準則以及儲存庫保護檔案。檔案發現僅限於一次使用這些副檔名和排除條件進行的 rg --files 列舉,上限為 200 個路徑;僅檢查該列舉傳回的路徑。對於已變更的公共概念,最多允許一次精確的、限制路徑的 rg -l -F 參考搜尋。如果達到上限或搜尋邊界,請報告未審查的部分,而不是擴大範圍。
決策規則
- 首先把關範圍。 如果未指定任何文件或章節,未觸及任何文件,且沒有需要檢查參考的公開重新命名/移除,則停止。不要檢查文件來決定是否要檢查文件。
- 編輯規範來源。 僅記錄開發者、使用者、操作者或維護者所需的持久性資訊:合約、設定、配置、操作、約束、不變量、非顯而易見的行為、遷移和關鍵警告。省略實作細節、臨時狀態、除錯歷史、推斷的事實和完成總結。
- 替換,而非堆積。 更新現有解釋,刪除過時文字,並在另一個文件需要指向時連結到一個規範來源。僅在遷移、相容性或架構理由需要時保留歷史細節。
- 保持清理局部化。 在編輯文件時,僅清理被觸及的章節以及附近有明確證據顯示為過時、重複、矛盾、被取代、誤導、不必要地冗長或與已變更/移除的概念相關的文字。如果證據需要大量調查,請保持原樣。
- 限制參考搜尋。 對於已重新命名、移除或變更的公開概念,最多允許一次精確的、限制路徑的搜尋。優先使用帶有文件 glob 模式且報告檔案名稱(而非完整匹配行)的
rg -l -F。在上述明確的專案級別模式之外,請勿盤點不相關的文檔、瀏覽文檔樹、執行儲存庫範圍的連結檢查、調查不相關的歷史記錄或建立清理代理。 - 盡量少建立檔案。 僅在任務中已知沒有合適的規範標的時,才為持久、獨特的資訊新增文件檔案。
保護
請勿投機地改寫生成的文檔、變更日誌/發行說明、授權或法律資料、行為準則、供應商/第三方文檔或儲存庫保護的檔案。遵守儲存庫指示並保留有意義的前置設定和中繼資料。
如果 Markdown 檔案包含:
---
disable-agentic-editing: true
---
除非使用者明確要求該檔案,否則請勿修改。此標記是 docdiet 的慣例:沒有任何工具會強制執行它,儲存庫指示無法移除其保護,只有對該檔案的明確請求才能覆蓋它。僅檢查候選檔案的保護;請勿掃描儲存庫以尋找標記。
完成
如果文件被觸及,僅對已觸及的檔案/章節進行靜態檢查:最終行為已在需要的地方記錄,過時文字僅在有證據的情況下被移除,範例和命令仍與實作相符,且受保護內容未更改。在專案級別模式下,將這些檢查應用於每個已觸及的檔案;請勿將驗證擴大為儲存庫範圍的連結或範例檢查。除非實作任務已經要求,否則請勿執行範例或命令。然後停止。
記錄持久的內容。替換而非堆積。清理任務所暴露的內容。不要追獵。