用途:指导对 adk-bot 提交的 ADK 文档变更进行严格审查,确保文档更新技术准确、篇幅适当并符合 ADK 文档规范(基于 Google 开发者文档风格)。
主要能力与流程:
- 核实与研究变更:确认 PR 标题简要描述更新主题,变更直接写入 .md 文件,未过早移除“do not merge”标签;检查可合并状态与 CI 状态,记录冲突和失败检查。从 PR 回溯到 issue 及具体条目,识别同一 issue 的多个 PR 并作为一组审查;若 PR 针对不同条目,先询问用户聚焦哪一个。搜索已关闭 issue 与已合并/被拒 PR,避免重新引入已被维护者否决的改动、API 或风格。
- 评估更新标准与架构:优先小而精准的更新,确认内容对开发者有学习价值且可操作,位置符合 ADK 文档信息架构,篇幅与优先级匹配具体代码变更。
- 对照源码与意图验证:不假设 AI 代码片段正确,所有代码示例需对照 https://github.com/google/adk-python 仓库交叉核对,确认变更实现并解决所引用 issue。
- 检查质量与风格:标题保持 h1/h2/h3 层级、不编号、用祈使式、标题中不用命令名;语言遵循 Google 开发者文档风格,用主动语态,“this”后必须接名词;Markdown 正文 80 字符行宽限制(长 URL、不可断代码块、表格除外);检查反引号前空格导致的渲染错误;提示与警告用 !!! warning/tip/note 的 mkdocs-material admonition 格式而非引用;除代码语法外不用全大写。
- 报告发现并给出建议:按阻塞项、必需修改、细节问题排序,然后选择关闭 PR、直接批准、就地修改后批准或新建合并 PR(最常见),并确认目标文件正确。
- 产出行动计划:列出具体本地编辑(文件路径、修改内容、代码修复、合并 1-3 个 PR、正确放置)、验证发现清单、需关闭的 PR,以及符合仓库约定的 PR 描述(变更要点、Rendered page、Agent PR 链接、Original issue)。
风格规则:示例代码用 gemini-flash-latest、gemini-pro-latest 等 *-latest 别名而非具体版本号;导入为 from google.adk.agents import Agent,MCP 用 from google.adk.tools.mcp_tool import McpToolset,Agent 变量为 root_agent(Python);不用破折号或冗长 AI 生成内容;提及 ADK 时只用“ADK”;句子不以行内代码词开头;内部链接为站点相对路径,外部链接必须可解析,不得虚构链接;所有代码示例需对照实际 API 与库代码验证,权威源仓库见 docs/community/contributing-guide.md。
限制:资料未提供具体安装命令、收费或平台信息。