Skip to content

文件維護護欄 ​

修改 CLAUDE.md、AGENTS.md、README、docs/ 或 AI 工作流程前必讀。

  • 唯一路由是 index.md;CLAUDE.md 不列文件清單,也不建立必須逐層點入的導覽頁。
  • 依可獨立修改的主題拆檔,不按固定行數硬切;路由直接指向葉文件,避免先讀導覽頁。
  • 禁止為了預算把同一個主題切成兩頁。 互相寫著「另一半見 X」的兩頁就是被切開的一頁: 合起來仍在預算內就合併回去,真的超出就先刪冗餘,刪不掉才拆,而且要拆在讀者只需要 其中一邊的地方。上限曾經是 4000,把三個約 4100 字元的主題各切成兩頁,每頁多付一段 純導覽文字,而索引那一列照樣兩份一起讀。
  • 每頁 H1 之後第一句寫「本頁包含什麼、不含的那一半在哪」,讓人在前三行就放得掉這一頁。
  • 同一規則只留一份。跨頁只放一句連結,不複述理由、表格或程式碼路徑。
  • 取捨理由寫在它解釋的那條規則旁邊,不另開「設計決策」頁:另開的那頁一定會重述規則, 規則改了它就過時。程式碼已有唯一出處的常數表(標題、時長、尺寸)也不抄進文件。
  • 不寫推導得出來又一定會過時的東西:哪一天做了什麼在 git log,自動測試涵蓋哪些案例 在測試專案,版號在程式碼。文件只留它們推不出來的判準、禁令與理由。
  • 驗收頁留可執行的驗證入口、不同證據不能互相替代的判準,以及必須在實機確認的視覺、 互動與宿主整合項目;不重列測試專案已有的案例、當次進度或程式碼問得到的版號。待驗 項目沒有別處追蹤時,留一節「尚未確認」列出還沒有結論的項目,確認後整節刪掉, 不要寫成日期流水帳。
  • 一句講一件事。刪掉不影響判斷的字:鋪陳(「值得注意的是」「基本上」)、加強語氣的 形容詞、段末總結、重述上一段已說過的前提。寧可刪句子,不要為了省字元把話寫成密語。
  • README 只做產品摘要、視覺化功能導覽、安裝與文件入口;實作細節放 docs/。精簡時不得 移除讓 GitHub 訪客直接理解主要功能的代表圖片。
  • 預算:CLAUDE.md 1000、AGENTS.md 400、索引 4500、README.md 6000、 其餘 Markdown 5000 字元;英文 README 超過 5500、其餘超過 4500 即警告。 字元只作穩定上限,不宣稱等於模型 token。預算是回頭刪冗餘的訊號, 不是拆檔門檻,更不是要寫滿的目標。
  • 不整檔讀超過 5000 字元;先查標題,再指定行號範圍讀命中區段。
  • 索引一列就是一次任務會讀的東西:第一份是入口,其餘碰到才讀;一列全部都必讀時才用 + 串起來。同一列的兩份長期一起被讀,就是該合併的訊號。
  • 文件完成後執行 tools/Check-Docs.ps1 與 tools/Check-TextFiles.ps1;改了這兩支檢查器時, 另外手動造一個會失敗的案例確認仍擋得下來。

以 Apache-2.0 授權條款發布 · 專為 SSMS 22 設計