git-doc-updater
Auto-check and update key documentation before Git commits to keep docs in sync with code. Triggers: docs, 文檔, 更新文檔, sync docs, release, 發布.
Best use case
git-doc-updater is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Auto-check and update key documentation before Git commits to keep docs in sync with code. Triggers: docs, 文檔, 更新文檔, sync docs, release, 發布.
Teams using git-doc-updater should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/git-doc-updater/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How git-doc-updater Compares
| Feature / Agent | git-doc-updater | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Auto-check and update key documentation before Git commits to keep docs in sync with code. Triggers: docs, 文檔, 更新文檔, sync docs, release, 發布.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Git 文檔自動更新技能 ## 描述 在執行 Git commit 之前，自動檢查並更新專案的關鍵文檔，確保文檔與程式碼保持同步。 ## 觸發條件 當用戶要求進行以下操作時啟用此技能： - Git commit - Git push - 提交程式碼 - 準備發布 ## 自動更新的文檔 ### 1. README.md - 更新專案描述（如有變更） - 更新安裝/使用說明 - 更新功能列表 - 更新依賴項目 ### 2. CHANGELOG.md - 根據本次變更添加新條目 - 遵循 [Keep a Changelog](https://keepachangelog.com/) 格式 - 分類為：Added, Changed, Deprecated, Removed, Fixed, Security - 包含日期和版本號（如適用） ### 3. ROADMAP.md - 標記已完成的功能項目 - 更新進行中的項目狀態 - 調整優先順序（如需要） ### 4. ARCHITECTURE.md (ARCH) - 更新架構圖和說明（如有結構性變更） - 更新組件關係 - 更新技術決策記錄 ### 5. Memory Bank 文件 更新 `memory-bank/` 目錄下的相關文件： - `activeContext.md` - 當前工作焦點 - `progress.md` - 進度追蹤（Done/Doing/Next） - `decisionLog.md` - 記錄重要決策 - `productContext.md` - 專案上下文（如有變更） ## 執行流程 ``` 1. 分析本次程式碼變更內容 2. 執行 MCP 工具統計同步（若涉及工具變更） 3. 識別哪些文檔需要更新 4. 依序更新各文檔 5. 顯示更新摘要供用戶確認 6. 將文檔變更加入 Git staging ``` ### ⚠️ 必要步驟：MCP 工具數量同步 當程式碼涉及 MCP 工具新增、移除或重新命名時，**必須**執行： ```bash uv run python scripts/count_mcp_tools.py --update-docs ``` 此腳本自動更新 6 個文件中的工具數量和列表。 ## 更新原則 - **最小變更**：只更新與本次提交相關的內容 - **保持一致性**：維持現有文檔格式和風格 - **自動摘要**：從 commit 內容推斷變更摘要 - **版本控制**：CHANGELOG 使用語義化版本 ## 範例輸出 當用戶說「準備 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` 只顯示將要更新的內容，不實際修改
Related Skills
roadmap-updater
Auto-update ROADMAP.md status based on completed features. Triggers: RM, roadmap, 路線, 規劃, 完成功能, milestone, 里程碑.
readme-updater
Intelligently update README.md to sync with code changes. Triggers: readme, 說明, 更新說明, update readme, 文檔同步.
memory-updater
Update and maintain Memory Bank files (activeContext, progress, decisionLog). Triggers: MB, memory, 記憶, 進度, 更新記憶, update memory, 記錄進度, 更新上下文.
changelog-updater
Auto-update CHANGELOG.md following Keep a Changelog format. Triggers: CL, changelog, 變更, 版本, version, 更新日誌, whatsnew.
academic-figure-drawing-harness
Codex drawing harness integration. Triggers: 繪圖, draw, figure, chart, plot, mermaid, SVG, Gemini, graph, 生成圖表.
zotero-keeper-harness
Cline harness for Zotero Keeper and the bundled VS Code extension. Triggers: zotero keeper, zotero mcp, full check, release checklist, workflow, vsix, Cline.
pubmed-search-mcp-harness
Cline harness for PubMed Search MCP. Triggers: pubmed search, literature search, unified_search, pipeline, fulltext, release checklist, Cline.
llm-wiki-builder
Build or refresh Foam-compatible LLM wikis from Zotero, PubMed, documents, and local Markdown notes using a multi-tool workflow.
asset-aware-mcp-harness
Cline harness for this repo (rules + workflows + checks). Triggers: cline harness, full check, release checklist, workflow, 文檔工作流, DFM, citation-ready.
tool-sync
Auto-sync MCP tool documentation when tools are added, removed, or renamed. Triggers: TS, tool-sync, 工具同步, 同步工具, sync tools, new tool, 新增工具, 工具變更, update tools.
test-generator
Generate comprehensive test suites including static analysis, unit tests, integration tests, E2E tests, and coverage reports. Triggers: TG, test, 測試, 寫測試, coverage, 覆蓋率, pytest, unittest, 驗證.
readme-i18n
Maintain multilingual README versions (English primary, Chinese translation). Triggers: i18n, 翻譯, translate, 多語言, sync readme, 中英文, bilingual.