用途
readme-updater 是一个用于智能更新 README.md 的技能,目标是让 README 文档与代码变更保持同步。它会在代码发生变化后,分析变更内容并给出 README 的更新建议,从而减少文档与实现不一致的情况。
主要能力
该技能围绕变更类型进行文档同步,主要覆盖以下更新场景:
- 新功能:更新功能列表
- 新依赖:更新安装说明
- API 变更:更新使用示例
- 结构变更:更新项目结构
- 配置变更:新增设定选项说明
- MCP 工具变更:同步工具数量与列表
在更新区块上,它按条件处理:功能列表在新增或移除功能时更新;安装说明在依赖变更时更新;使用范例在 API 变更时更新;项目结构在目录结构变更时更新;配置说明在新增设定选项时更新;工具数量在 MCP 工具变更时更新。
触发方式
触发条件包括:
- 「更新 README」
- 被 git-precommit 编排器调用
- 新增重要功能后
触发词包括:readme、說明、更新說明、update readme、文檔同步。
特殊同步要求
当 MCP 工具有新增或移除时,资料要求先执行以下命令:
uv run python scripts/count_mcp_tools.py --update-docs
该脚本会自动更新所有文档中的工具数量和列表,包含:
- README.md / README.zh-TW.md(工具数量)
- copilot-instructions.md(工具数量 + 列表)
- TOOLS_INDEX.md(完整工具索引)
- instructions.py(MCP Server 内嵌工具列表)
- pubmed-mcp-tools-reference SKILL(完整工具参考)
使用方式与输出
该技能会输出 README 更新分析,格式包含变更侦测、建议更新和预览。例如:
📝 README 更新分析
變更偵測:
✅ 新增功能:用戶認證模組
✅ 新增依賴:bcrypt
建議更新:
[功能列表] 新增「🔐 用戶認證」
[安裝說明] 新增 bcrypt 安裝指令
預覽:
## 功能
- 🤖 Claude Skills
- 📝 Memory Bank
+ - 🔐 用戶認證(新增)
适用场景
适合在新增重要功能后维护 README,或在提交前通过 git-precommit 编排器调用以实现文档同步。适用于需要保持 README 与代码一致性的项目,尤其是包含 MCP 工具的项目。
限制与边界
以下区块不会自动修改:
- 授权信息
- 贡献指南
- 致谢
资料中提及法规依据为宪法 CONSTITUTION.md 第 6 条。关于该技能的收费、价格、支持平台、具体实现语言与依赖版本等信息暂未提供。