工程開發
doc-sync avatar

doc-sync

同步儲存庫中的 CLAUDE.md 導航層級與 README.md 隱性知識文件,確保 AI 代理具備一致且即時的上下文。

簡介

doc-sync 技能是一項專業的文件維護工具,旨在解決 AI 輔助編程中常見的程式碼退化與技術債問題。它強制執行嚴格的雙檔案文件模式:CLAUDE.md 用於提供機器可讀的最小化表格索引,而 README.md 用於記錄無法單從原始碼導出的架構性「隱性知識」。透過維持此結構,該技能確保 AI 代理在執行特定任務時,能夠接收精確的上下文,而不會被無用的文字淹沒,從而實踐即時上下文衛生原則。

  • 執行自動化的儲存庫級別審計,以驗證目錄結構與索引完整性。

  • 根據內容測試,將原本錯誤放置在 CLAUDE.md 中的架構性內容遷移至 README.md。

  • 支援範圍操作,允許使用者同步整個專案、特定目錄或單一檔案父目錄的文件。

  • 在每次執行後生成結構化報告,詳述建立、修改、遷移與偏差修正的度量數據。

  • 執行發現階段,映射目錄樹,同時排除如建置產物、供應商目錄與編輯器設定等無關檔案。

  • 執行內部文件標準中定義的嚴格約定,確保程式碼庫的一致性。

  • 最適用於引入新開發者或 AI 代理至程式碼庫時,確保導航清晰。

  • 非常適合高變更率的專案,解決文件容易滯後的問題。

  • 操作限制:該技能依賴於手動或半自動地遵守雙檔案模式,以保持其有效性。

  • 輸入:通常透過自然語言指令觸發,例如「同步文件」(sync docs) 或「更新說明文件」(update documentation)。

  • 輸出:更新後的 Markdown 檔案,遵循特定的導航索引與隱性知識格式,並附帶總結狀態報告。

  • 目標用戶為後端工程師與技術主管,他們將 AI 輔助編程視為一個需要嚴謹性、計畫與系統化上下文管理的工程問題,而非單純的程式碼產生過程。

倉庫統計

Star 數
813
Fork 數
127
Open Issue 數
11
主要語言
Python
預設分支
main
同步狀態
閒置
最近同步時間
2026年4月29日 上午03:30
在 GitHub 查看