SuperAPI AI 工具集

update-claude-documentation

智能体与模型

查看项目

更新于 10-16 08:03

技能介绍

用途:在代码、架构、工作流或指令发生有意义变更后,系统性更新仓库文档,覆盖通用项目文档以及 CLAUDE.md、AGENTS.md 等面向智能体的指令文件,使 Claude Code 与 Codex 看到一致的现实。

主要能力:识别变更及其影响对象,将变更映射到需更新的文档;先更新最具体的技术文档(API、数据库),再更新架构、CLAUDE、README 与项目概览;检查术语、示例、路径、版本与工作流说明的跨文件一致性;标记破坏性变更与迁移说明;记录遗留文档债务。

使用方式:先理解变更类型、影响与是否破坏兼容,再按“具体到一般”的顺序读取并更新受影响文件,最后做一致性校验。建议模块化指令,避免把所有内容塞进单个 CLAUDE.md,可拆分为 docs/setup.md、docs/api.md、docs/workflows.md 等按需引用。

适用场景:新增或移除功能、架构或设计模式变化、依赖与技术栈更新、API 端点或数据库结构变更、目录重构、开发工作流变化。

限制:不用于琐碎拼写修正或孤立措辞调整;不应只更新单个文件而忽略共享叙述;缺少变更实现或验证证据时,只返回影响映射并标注事实更新未评估,不得凭记忆更新版本、计数或状态;仅编辑文档,不修改应用行为、不对外发布、不发送消息;执行限于安全的链接、语法、计数与仓库校验。

分类:办公与效率。