docs-generator

docs-generator 技能為技術文檔提供了一種系統化的方法，專為 AI 優先的開發環境而設計。透過建立輕量級、層級化的文檔結構，它確保了 AI 編碼助手（如使用 AGENTS.md 或 agent.d 格式的助手）能在不消耗過多 Token 的情況下獲得與上下文相關的資訊。此技能彌合了凌亂的代碼庫與現代 AI 開發工具結構化需求之間的差距。它專為軟體架構師、後端工程師以及在 monorepo 或多套件專案中工作的開發者而設計，這些開發者需要為自己及其 AI 助手維護清晰、可操作的指導。

• 自動生成從根目錄設置命令到模組級實現細節的層級化文檔樹。

• 支援多種輸出格式，包括標準的 AGENTS.md、專用的 agent.d 配置以及可自定義的文檔類型。

• 實作「最近優先」邏輯，確保 AI 助手優先讀取與當前檔案最接近的文檔，最大限度減少噪聲與幻覺。

• 透過搜尋 Glob、檔案路徑映射及快速搜尋終端命令提供即時索引 (JIT)，而非轉儲原始檔案內容。

• 具備存儲庫分析功能，可偵測技術棧、建構系統及主要目錄結構，以實現量身定製的文檔佈局。

• 包含預檢檢查與「完成定義」(DoD) 模板，以確保團隊提交與 PR 的一致性。

• 在執行前，請與使用者確認文檔格式（AGENTS.md 或 agent.d）及目標範圍（根目錄或子資料夾），以保持專案規劃的一致性。

• 根目錄文檔應保持輕量，理想情況下控制在 200 行以內，作為詳細子資料夾文檔的入口。

• 務必利用 JIT 索引功能來保持文檔的可維護性；避免在文檔中重複複製完整的程式碼區塊。

• 與使用 pnpm workspaces、Turborepo 或 Lerna 的專案搭配使用效果最佳，因為它可以自動發現這些結構模式。

• 利用「常見陷阱」與「模式與規範」部分來記錄關於檔案組織與團隊特有反模式的經驗知識。