SuperAPI AI 工具集

docs-review

写作与研究

查看项目

更新于 10-16 00:29

技能介绍

用途:docs-review 是 Metabase 项目提供的文档审查技能,依据 Metabase 写作风格指南,检查文档改动是否符合规范。适用于审查拉取请求、文件或包含文档的 diff。

主要能力:技能会先检测审查模式。若可用 mcp__github__create_pending_pull_request_review 工具,则进入 PR 审查模式,通过待处理审查工作流把问题作为一次完整审查发布;若该工具不可用,则进入本地审查模式,在对话中以编号 Markdown 列表输出问题。审查清单覆盖语气与口吻、结构与清晰度、链接与引用、格式、代码与示例、句子构造等方面,例如避免正式或企业化措辞、避免用“users”而尽量用“people”或“companies”、避免“easy/simple/just”等居高临下限定词、链接文字需具描述性、标题中避免链接、代码示例需可运行、命令需按执行顺序排列等。

使用方式:PR 模式下,先创建待处理审查,再获取 PR diff 以确定文件路径与行号,识别全部值得提出的问题并顺序编号,随后用并行工具调用一次性添加所有评论,每条评论以“Issue N: [Brief title]”开头,最后提交审查,事件类型用 COMMENT 而非 REQUEST_CHANGES,且不填写正文。本地模式则直接在对话中按编号格式输出问题。

限制:只标记对读者有实质影响的问题,不提出无足轻重的意见;所有问题必须从 Issue 1 开始连续编号,格式须严格匹配;PR 模式下不在对话中输出摘要,只发布 GitHub 审查评论。资料未提供安装命令、收费或平台支持等更多信息。