代理文件紀律
使用此技能在建立或編輯任何代理會讀取以採取行動的文件時,套用撰寫時的紀律。這些文件包括五大面向(CLAUDE.md、CONTEXT.md、docs/standards/、design-system/、.omc/skills/)、規格、工單及技能檔案。文件必須通過的測試是:一個全新的代理工作階段只需讀取該文件即可據以行動。
強制使用時機:drydock 生成表面種子時、launch C5 sediment pass 將經驗寫入插槽時。其他編輯則為選用——但任何對代理導向文件的編輯都應能承受這些規則的考驗。
何時不使用
僅供人類閱讀的文件:docs/business/ 敘述性內容、ADR 決策故事、新人引導用的 README。這些文件仍可無償遵循規則,但不受此紀律約束。
紀律內容
為沒有聊天記錄的讀者而寫。 文件應自我描述:不依賴「如先前討論」、先前的會話或存在於任何人腦中的知識。測試: 一個全新的代理工作階段只需讀取文件即可據以行動。
每條規則皆可校驗且附帶原因。 不要寫「保持乾淨」——應寫出可觀察的條件及其理由。測試: 代理可僅從文字判斷通過/不通過,且原因緊鄰規則敘述。
一個意義,一個歸屬。 每條規則或定義只有一個權威位置;重複就是偏移的源頭。測試: 改變行為只需編輯一個位置。
絕不重述環境已知的資訊。 套件腳本、目錄結構、--help 輸出都是可以查詢的內容,不是文件——複製查詢結果會過時。只記錄無法透過查詢找到的內容:未成文的慣例、選擇背後的原因、陷阱。測試: 每一行都要通過「這能否在其他地方查到?」的考驗。
步驟優先,參考在後,罕見素材置於指標之後。 該做什麼、順序為何,放在最上方;需要時查閱的規則放在下方;低頻率素材推到一個指標之後,該指標的用詞應能指出哪些分支應觸發查閱。測試: 下一個行動在第一個畫面內就能找到。
每個步驟結尾都有完成標準。 「完成」必須能與「未完成」區分——模糊的界限會導致過早完成。測試: 對每個步驟,「我怎麼知道這完成了?」都能在文字中找到答案。
引導正面行為。 陳述目標行為;禁止語句僅用於硬性護欄,且必須搭配正面的目標行為。測試: 文件中的每個禁止語句都指出了應採取的替代行為。
寫入時清理附著物。 當文件中包含過時或冗餘的內容時,應在同一編輯中移除;若無,則僅加入所需素材,不得發明不存在的刪除項目。對於模型預設即會遵守的句子,它只會白白增加負擔——應刪除整個句子。測試: 每一行重讀時都要能證明其存在價值(相較於預設行為是否改變了行為?),且在編輯過程中發現的任何過時或冗餘內容都已被移除。
驗證
在回報文件變更完成前,請確認:
- 一個全新的工作階段只需讀取文件即可行動,無需向人類提問
- 每條規則皆可校驗且附帶原因;沒有規則重述可查詢的資訊
- 意義只存在於一個位置;指標的名稱指出了觸發分支
- 編輯過程中發現的過時或冗餘內容已被移除,而有效的無關內容則被保留