用途:在代码变更后自动审查提交并同步面向用户的文档,使文档与代码库保持一致。
主要能力:识别需要更新文档的提交(默认最近 24 小时,也可指定时间范围),筛选新功能、API 变更、破坏性变更、新配置项、新 CLI 命令或参数、用户可见行为变化;跳过内部重构、仅测试改动、小修复、代码拼写修正和无用户影响的性能优化。随后定位文档(当前仓库目录或独立文档仓库),通过配置文件与目录结构判断文档平台,阅读现有文档以掌握语气、结构、术语和代码块格式,再生成匹配风格的更新内容。
使用方式:测试模式会输出文字摘要,说明检测到的变更、将修改的文档文件、拟新增或修改的内容及理由;执行模式会创建描述性分支(如 docs/auto-update-YYYYMMDD),修改文档、推送并创建 PR,PR 描述关联相关提交并请求审核。多仓库场景下先在源码仓库识别变更,再切换到文档仓库执行同一流程,并在 PR 中引用源码提交。
适用场景:代码与文档需要持续同步的团队,尤其是使用上述文档平台、单仓或多仓结构的项目。
限制与原则:保守优先,宁可跳过也不堆砌文档;严格匹配现有风格与结构;尽量只做增量修改,保留已有准确内容;平台不明确时默认使用标准 Markdown;与现有内容冲突时保留原信息并标注供人工审核;未发现重要变更时报告无需更新。资料未提供具体安装命令、收费方式或平台支持范围之外的细节。