用途
git-doc-updater 用于在 Git 提交之前自动检查并更新项目的关键文档,确保文档与代码保持同步。
触发条件
当用户要求进行以下操作时启用此技能:Git commit、Git push、提交代码、准备发布,用户说「準備提交」等。
可更新的文档
- README.md:更新项目描述(如有变更)、安装/使用说明、功能列表、依赖项目。
- CHANGELOG.md:根据本次变更添加新条目,遵循 Keep a Changelog 格式,分类为 Added、Changed、Deprecated、Removed、Fixed、Security,包含日期和版本号(如适用)。
- ROADMAP.md:标记已完成的功能项目、更新进行中的项目状态、调整优先级(如需要)。
- ARCHITECTURE.md (ARCH):更新架构图和说明(如有结构性变更)、更新组件关系、更新技术决策记录。
- Memory Bank 文件:更新 memory-bank/ 目录下的相关文件,包括 activeContext.md(当前工作焦点)、progress.md(进度追踪,Done/Doing/Next)、decisionLog.md(记录重要决策)、productContext.md(项目上下文,如有变更)。
执行流程
- 分析本次代码变更内容。
- 识别哪些文档需要更新。
- 依序更新各文档。
- 显示更新摘要供用户确认。
- 将文档变更加入 Git staging。
更新原则
- 最小变更:只更新与本次提交相关的内容。
- 保持一致性:维持现有文档格式和风格。
- 自动摘要:从 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 只显示将要更新的内容,不实际修改