文档机器人:自动审阅代码变更并更新面向用户的文档,使其与代码库保持同步。兼容 Mintlify、Docusaurus、GitBook、Fumadocs 等文档平台,支持 monorepo 与多仓库设置。
工作流程:1)识别重要代码变更:确定默认分支,获取近期提交(默认最近 24 小时,也可由用户指定时间范围),检查每个提交的改动;筛选出重要变更,如新功能或能力、API 变更(新端点、参数、返回值)、破坏性变更、新配置项、新 CLI 命令或标志、面向用户行为的变化;跳过内部重构、仅测试改动、次要缺陷修复、代码拼写修正、无用户影响的性能优化。原则是保守,质量优先于数量,存疑时跳过。2)分析文档上下文:在当前仓库查找文档目录(monorepo 模式),或查找环境中独立的文档仓库;通过配置文件和目录结构判断文档平台;阅读若干现有文档以了解语气、结构、代码示例模式、术语与格式约定,并查看风格指南或贡献说明。3)确定文档更新:把代码变更映射为文档需求(新增内容、修改或补充现有内容);优先面向用户的变更,匹配现有文档详略程度,尽量保持内容增量、不改动已准确的内容,聚焦具体内容、避免泛泛建议。4)生成文档修改:沿用已识别的语气、正式程度、标题层级与术语,匹配代码块格式(语言标签、高亮)和平台约定(frontmatter、特殊语法、自定义组件)。5)执行或报告:测试模式输出文字摘要,说明检测到的变更、将修改的文档文件、将新增或改动的内容及理由;执行模式则创建描述性分支(如 docs/auto-update-YYYYMMDD)、修改文档、提交(含 Co-Authored-By: Warp agent@warp.dev)、推送并创建 PR,在 PR 描述中列出哪些代码变更触发哪些文档更新并附提交引用或 URL,请求审阅。多仓库场景下先在源码仓库识别变更,再切到文档仓库执行上述流程,并在 PR 描述中引用源码提交。边界情况:无重要变更时报告无需更新;平台不明确时默认标准 markdown 语法;与现有内容冲突时保留现有信息并标注供人工审阅。核心原则:保守、一致、结合全局上下文、说明理由、以帮助用户完成任务为目标。