SuperAPI AI 工具集

review-docs

写作与研究

查看项目

更新于 10-16 08:27

技能介绍

用途

review-docs 是 Apify 文档仓库(apify/apify-docs)中的一个文档审查技能,用于检查 Apify 文档是否符合风格指南、质量标准与最佳实践。当用户说出“review this doc”“check this page”“audit…”等请求时使用。

主要能力

该技能覆盖三类审查:

  1. 确定性检查(主流程):这些检查是客观的,无需人工判断。

    • vale --minAlertLevel=suggestion "<file>":检查行文风格,包括语气、语调、术语、语法、标题、链接文本。
    • pnpm lint:md:检查标题层级、列表编号、间距。
    • .agents/skills/review-docs/scripts/check-frontmatter.sh "<file>":检查 description 字符数。
    • 说明:Vale 承载了大部分风格指南内容,因此不要手工重复检查它已覆盖的部分。如果 Vale 未安装,应说明并注明行文覆盖被跳过。
    • 对于 pull request,需对每个改动的 .md 和 .mdx 文件运行以上三项检查,并按文件报告。
  2. 委派审查:并行启动两个子代理,检查工具无法覆盖的内容。每个子代理阅读被审查页面以及一个标准文件,返回带行号和修改建议的发现。

    • 子代理 1,依据 standards/style-guide.md:检查 UI 元素和关键警告之外的加粗、未说明去向的链接文本、非平行列表、缺失的序列逗号,以及“legacy”“alternative”“deprecated”的宽松使用。
    • 子代理 2,依据 standards/page-structure.md:检查堆叠标题、概念在解释前被使用、不配其位的截图或违反处理规则的截图、与内容不符的提示框、每个 H2 小节超过一个提示框、或提示框承载了正文所需内容。
  3. 内容审查(主流程):聚焦工具和标准都未覆盖的内容。

    • 内容结构(清晰的引言、逻辑流程、后续步骤)
    • 技术准确性(代码示例正确、API 端点最新)
    • 完整性(列出前置条件、覆盖边界情况)
    • 代码示例质量(完整、可运行、必要时有注释)

使用方式

按流程执行:先用 git status 确认文件版本为最新;然后运行确定性检查;对 PR 则对所有改动的 .md 与 .mdx 文件运行三项检查并逐文件报告;接着并行启动两个子代理进行委派审查;随后在主流程进行内容审查;最后按 .agents/skills/review-docs/references/review-format.md 格式化输出。工具输出放在独立小节,逐字保留规则名和行号;人工判断发现放在另一小节,且不得重复工具已报告的内容。

适用场景

适用于审查 Apify 文档页面或 pull request 中的文档改动,检查其是否符合风格指南、页面结构标准与内容质量要求。

限制

  • 若 Vale 未安装,行文覆盖会被跳过,需明确说明。
  • 工具输出与人工判断发现必须分节呈现,人工发现不得重复工具已报告内容。
  • 更多详细流程说明和边界情况见 .agents/skills/review-docs/references/process.md。
  • 关于收费、价格、平台支持范围等信息,资料暂未提供。