SuperAPI AI 工具集

docs-review-pr

写作与研究

查看项目

更新于 10-16 05:07

技能介绍

用途:对 Elastic 文档拉取请求(PR)执行完整审查,覆盖文档团队审查清单的六项标准——用户聚焦、技术准确性、适用性、可维护性、语言、风格,并给出批准、评论或要求修改的建议。它本身是编排者,不重新实现各子技能的评分标准,而是调度目录中已有的风格、标签、内容类型、矛盾、元数据、代码示例等检查技能,把结果合并成清单形式。

主要能力:始终执行完整审查,没有轻量模式;只读,不编辑文件、不在暂存区外写文件、不向 GitHub 发布评论或合并;所有伴随技能以仅报告模式调度。输入可为 PR 编号、GitHub PR URL、文件或目录;为空时审查当前分支相对其基线。

使用方式:先读取 references/review-criteria.md 作为评分标准;若 elastic-internal-docs MCP 可达,则用 get_internal_document_by_url 刷新规范页面,冲突记入报告。解析目标时用 gh pr view 与 gh pr diff 获取元数据与差异,并解析 $BASE 与 $BASE_REPO;分支模式用 gh pr view --json baseRefName 或仓库默认分支,从基线仓库按 URL 拉取后 git diff -U0 "$(git merge-base HEAD FETCH_HEAD)"...HEAD。确认工作树与 PR 一致需 git rev-parse HEAD 等于 headRefOid;不匹配时先确认仓库,再询问是否运行 gh pr checkout <n>,用户拒绝则降级到暂存区副本审查。随后逐文件通读变更的 .md,删除或重命名页面需从基线读取,非 Markdown 的导航与重定向文件也在范围内。

适用场景与限制:适用于 Elastic 文档仓库的 PR 审查与 CI/智能体工作流。限制包括:无网络、无 MCP、无认证时仅靠参考文件;路径输入无差异,所有行视为在范围内;仓库卫生类检查在降级模式下标记为未检查;作者角色只能依据真实证据推断,证据不足记为未知。