doc-updater

doc-updater 技能是一款主動式文件維護工具，專為需要維持程式碼與技術文件同步的軟體開發人員與技術主管所設計。透過分析 Git 差異與套用模式匹配啟發法，代理程式能識別專案中需要更新的特定區域（如 CLI 介面、API 端點、環境變數與設定綱要），以確保文件內容正確。此工具能自動化將程式碼修改與 README.md、CHANGELOG.md 及 docs/ 資料夾中的文件進行交叉比對的繁瑣過程，減輕開發人員的認知負擔。對於遵循嚴格版本控制工作流程或預先合併檢查清單 (pre-PR checklists) 的團隊特別有效，確保文件不是事後才處理的工作，而是開發週期不可或缺的一部分。

• 使用正規表達式模式自動掃描變更的程式碼，識別修改後的 API 路徑、新增的 CLI 選項或更新後的環境變數。

• 提供結構化的 Markdown 格式建議，並使用 diff 風格語法，使變更的應用過程變得無縫接軌。

• 與標準儲存庫結構整合，支援 Markdown、README 檔案、API 規範與設定指南等多種文件類型。

• 具備內建的互動式工作流程，提供「文件影響報告」，讓使用者在執行前能審核並核准特定的更新建議。

• 鼓勵最佳實踐，確保針對重大變更、新功能與安全性修補程式及時更新 CHANGELOG。

• 促進與程式碼品質檢核 (code-quality-gates) 及自動化 PR 檢查清單工具等二次工具的整合。

• 適合在 Python 環境中開發，或在儲存庫中直接維護文件的專案開發人員使用。

• 工具運作前提是專案中需包含既有的文件檔（例如 .md 檔案、docs/ 目錄）。

• 使用如 git diff 的標準 Git 操作來追蹤變更，因此最適合在已初始化的儲存庫中使用。

• 儘管在結構化更新方面非常有效，使用者仍應針對需要程式碼本身未涵蓋之領域特定知識的複雜文件變更進行手動驗證。

• 支援透過技能設定中的 Python 指令碼自訂偵測模式，以針對特定專案需求調整探索規則。