用途:在代码或配置变更后更新文档,审计文档与实现之间的漂移,或准备 README、API 文档、运维手册、发布说明等。
主要能力:先读取仓库说明与相关代码差异、提交或发布范围,检查工作区已有改动并在文档编辑重叠时停止等待指示;为每条陈述确定事实来源(代码、schema、生成的规范、配置、脚本或操作流程);在现有文档中搜索受影响的名称、命令、路由、环境变量、默认值和链接;判断受众并确定必须改动的最小文档面。
使用方式:不新建文档层级、不重复生成内容、不重写无关文字;生成的文档只通过其生成器修改。更新时保持既有结构、术语、语气、标题、锚点和版本方式,命令与示例保持可复制运行并与仓库脚本及支持平台一致。仅在代码变更产生时记录用户可见行为、API 或 schema 变更、配置与默认值变更、迁移、回滚步骤和运维影响。密钥须标记为密钥,不得粘贴真实凭据或生产值。仅当仓库已有 ADR 记录且变更为持久架构决策时才添加 ADR,适用时可参考 references/adr-template.md。
验证:运行现有 Markdown lint、链接检查、片段测试、API 生成检查或文档构建;否则直接对照事实来源核验改动的命令、路径、锚点、环境变量名和示例。最后报告改动的文件、各自记录的行为、执行的验证以及有意保持不变的文档。
限制:资料未提供具体安装命令、平台支持范围、收费方式或效果数据。