SuperAPI AI 工具集

git-doc-updater

通用与其它

查看项目

更新于 10-16 09:44

技能介绍

用途:在 Git commit 或 push 前,自动检查并更新项目关键文档,使文档与代码同步。触发场景包括提交代码、准备发布及更新文档等要求。

主要能力:按顺序处理多类文档——README.md(项目描述、安装使用说明、功能列表、依赖);CHANGELOG.md(按 Keep a Changelog 格式新增条目,分类 Added、Changed、Deprecated、Removed、Fixed、Security,含日期与版本号);ROADMAP.md(标记完成项、更新进行中状态、调整优先级);ARCHITECTURE.md(架构图、组件关系、技术决策记录);Memory Bank 目录下的 activeContext.md、progress.md、decisionLog.md、productContext.md。

执行流程:分析本次代码变更,涉及工具变更时执行 MCP 工具统计同步,识别需更新的文档,依次更新,显示更新摘要供确认,再将文档变更加入 Git staging。当代码涉及 MCP 工具新增、移除或重命名时,必要步骤为:uv run python scripts/count_mcp_tools.py --update-docs,该脚本会更新 6 个文件中的工具数量与列表。

可自定义选项:--skip-readme、--skip-changelog、--skip-memory 分别跳过对应更新,--dry-run 只显示将更新的内容而不实际修改。

更新原则:最小变更、保持与现有格式风格一致、从 commit 内容推断摘要、CHANGELOG 使用语义化版本。

限制:资料未提供具体适用范围、依赖环境及失败处理方式,暂未提供。