Auto-check and update key documentation before Git commits to keep docs in sync with code. Triggers: docs, 文檔, 更新文檔, sync docs, release, 發布.
在執行 Git commit 之前,自動檢查並更新專案的關鍵文檔,確保文檔與程式碼保持同步。
當用戶要求進行以下操作時啟用此技能:
更新 memory-bank/ 目錄下的相關文件:
activeContext.md - 當前工作焦點progress.md - 進度追蹤(Done/Doing/Next)decisionLog.md - 記錄重要決策productContext.md - 專案上下文(如有變更)1. 分析本次程式碼變更內容
2. 執行 MCP 工具統計同步(若涉及工具變更)
3. 識別哪些文檔需要更新
4. 依序更新各文檔
5. 顯示更新摘要供用戶確認
6. 將文檔變更加入 Git staging
當程式碼涉及 MCP 工具新增、移除或重新命名時,必須執行:
uv run python scripts/count_mcp_tools.py --update-docs
此腳本自動更新 6 個文件中的工具數量和列表。
當用戶說「準備 commit」時:
📝 文檔更新檢查:
✅ README.md - 無需更新
✅ CHANGELOG.md - 已添加 v1.2.0 條目
✅ ROADMAP.md - 已標記「用戶認證」為完成
⏭️ ARCHITECTURE.md - 無結構性變更,跳過
✅ memory-bank/progress.md - 已更新進度
準備提交以下文件變更...
用戶可以透過提示指定:
--skip-readme 跳過 README 更新--skip-changelog 跳過 CHANGELOG 更新--skip-memory 跳過 Memory Bank 更新--dry-run 只顯示將要更新的內容,不實際修改