用途:在代码发生功能、修复或重构变更后,更新文档使其与当前代码一致,并便于目标读者理解。
主要能力:通过 git diff 定位受影响区域;盘点仓库中的文档面,如 README.md、docs/、CONTRIBUTING.md、CHANGELOG.md、openapi.*、schema.graphql、adr/、runbooks/;判断需要更新的内容,包括安装与本地开发命令、必需环境变量与配置键、API 契约变更(请求/响应示例)、数据库迁移与运维步骤、用户可见的行为变化;对架构或行为决策添加或更新 ADR。
使用方式:先确认变更内容与目标读者、需要关注的文档面、格式或语气要求。用 git diff --name-only 和 git diff 定位影响范围,盘点文档位置,按清单决定更新项,以最小改动应用编辑,优先小范围定向修改而非重写,添加可直接复制运行的示例,保持标题稳定以免破坏深链接。最后运行仓库已有的文档检查(如 md lint、文档构建、站点构建),至少确保代码围栏中的命令与文件路径、环境变量名与代码一致。
适用场景:README、文档站点、API 文档、运维手册、配置文档的同步更新;Spring 项目可检查生成的 OpenAPI/Swagger 文档或端点注解,Next/TypeScript 项目可检查文档页面、Storybook 或类型化 API 客户端。
限制:资料未提供具体安装命令、收费方式、平台支持或效果数据;实际使用需依赖仓库自身的文档检查工具与结构约定。