控制文件增生
核心原則
- 以資訊可被正確找到與維護為目標,不以文件數量或交付痕跡為目標。
- 預設更新既有文件。找不到完美的放置位置,不等於必須新增文件。
- 維持單一真實來源;不要在多份文件重複保存相同規則、狀態或決策。
- 不要為了保留推理過程、工作紀錄或階段成果,自行建立使用者未要求的文件。
- 使用者明確要求特定文件時,建立該文件,但不要再衍生摘要、補充版或交接版。
寫入前先盤點
- 先查看現有文件的檔名、目錄與標題,再只讀取相關段落;不要一開始載入所有文件全文。
- 找出最接近的既有唯一真實來源,以及它的讀者、用途與維護生命週期。
- 將內容分類為:補充既有內容、取代過時內容、拆分過大內容,或建立獨立主題。
- 若既有文件可以清楚承接內容,直接更新該文件並停止新增檔案的評估。
新文件准入門檻
只有在沒有合適的既有文件可以承接內容,且符合至少一項必要性時,才新增文件:
- 讀者、維護者、權限或生命週期與既有文件明確不同。
- 內容具有可獨立維護的穩定目的,放入既有文件會混淆其責任。
- 既有文件已難以導覽或維護,拆出一個內聚主題能實質改善可讀性。
- 專案慣例、工具鏈、法規或使用者明確要求必須使用獨立文件。
以下理由本身不足以新增文件:
- 進入新階段、日期改變或版本名稱改變。
- 想保留工作歷程、推理過程、暫存研究或完成證明。
- 覺得新增檔案比整理既有章節更方便。
- 想同時建立摘要、快速參考、完整版本與最終版本。
- 未來可能有用,但目前沒有明確讀者或維護責任。
更新與拆分規則
- 優先新增或重整既有章節,並直接取代已失效的描述;不要在文件尾端無限追加補充說明。
- 移動內容時,保留一份權威版本並更新既有連結;只有在權限與安全條件允許時,才移除確認無引用的重複內容。
- 必須拆分時,只拆出一個職責內聚的主題,讓原文件保留摘要與直接連結。
- 讓所有延伸文件由主要入口直接連結,避免多層索引與深層引用鏈。
- 不要自行建立 README、CHANGELOG、快速參考、安裝指南或交接文件,除非它們是產品慣例或明確交付物。
- 不要手動修改由程式產生的文件;應更新來源或產生流程。
執行與回報
- 在動手前決定要更新的既有文件;若 Codex 主動新增使用者未指定的文件,先在 commentary 說明無法併入既有文件的原因與通過的准入門檻。
- 只修改完成目前需求所需的最少文件,不順便整理無關文件。
- 完成後檢查新內容是否造成重複規則、衝突來源、失效連結或未要求的衍生文件。
- 若沒有文件變更的必要,明確保留現狀並繼續原任務,不要為了使用本 Skill 而建立文件。
寫入前先在目前對話建立以下決策紀錄;不要將它另存為專案文件:
決定:更新既有文件/新增一份文件/不變更文件
權威來源:既有承接檔案,或新文件將承擔的唯一責任
新增門檻:不適用,或已通過的具體門檻與證據
變更範圍:本次會修改或新增的最少文件清單
停止理由:內容已位於正確來源,且沒有必要的衍生文件
若資訊仍不足以判斷權威來源或新增門檻,先完成必要的唯讀查證,不要用猜測填滿欄位。小型變更也使用相同欄位,但每欄一句即可,不要為了完整格式擴大盤點或建立正式 plan。
停止條件
當需求已放入正確的唯一真實來源、必要連結有效,且沒有重複內容時,立即停止文件工作。除非使用者要求,不要再建立摘要、歷程、索引、交接或後續規劃文件。