用途:分析当前分支相对基线的源码改动,找出文档中过时、不准确或缺失的内容,并在创建 PR 前检查文档是否需要同步更新。
主要能力与模式:报告模式(本地开发默认)输出按文档文件分组的结构化发现,并给出修复建议;编辑模式(CI)直接修改已有文档页面,但不创建全新页面,缺失内容改在 PR 正文中作为建议列出。模式由调用方式决定。
工作方式:先用 git diff main...HEAD --name-status 或 git diff main...HEAD -- 'src/prefect/' 'src/integrations/' 确定差异,CI 中读取 /tmp/diff.patch;过滤掉测试、CI、文档、锁文件和 ui-v2 等非源码改动。随后提取用户可见的公共 API 变化(函数与类签名、CLI 命令、配置项、行为变更),映射到现有文档,并归类为过时、缺失或失效示例。
限制与注意:编辑前须阅读 .claude/skills/write-docs/SKILL.md 并遵循其语气、组件、frontmatter、代码块和测试指令约定。禁止搜索、标记或编辑自动生成内容,包括 docs/v3/api-ref/、docs/v3/examples/ 及含 generated-by 注释的文件。编辑须尽量小、只修具体问题,不重写周边内容;修改代码块时保留 pmd-metadata 指令,确不可测时才加 {/* pmd-metadata: notest */}。报告模式可执行 just lint 检查 Vale 风格,并在改动代码块时运行 markdown 测试。其他平台与收费信息暂未提供。