SuperAPI AI 工具集

docs-audit

测试与质量

查看项目

更新于 10-16 11:22

技能介绍

用途:docs-audit 是对已有文档页面做评估的技能,面向已发布页面,给出结构化评估和改进建议。它不同于 docs-reviewer(后者是面向草稿的语气/风格门禁,在 docs-writer 末期运行);docs-audit 用来判断哪些内容需要改进,适合在重写页面前先了解现状、社区反馈显示某主题易混淆、定期文档健康检查,以及对比 Strands 文档与竞品文档时使用。

输入:目标页面(site/src/content/docs/ 下的文件路径或已发布 URL);内容类型(未知则先分类);可选上下文(社区信号、GitHub issue 或具体关注点)。

流程:一,读取源文件或从 strandsagents.com 获取已发布版本,并将内容分类为教程、操作指南、参考、解释或混合(“混合”本身即为一项发现)。二,按 voice-guide.md 中的语气栈逐层检查结构、框架、语域、硬约束与真实性。三,按 code-verification.md 做准确性核验:对照 SDK 源码检查导入、参数名、类型、默认值和方法签名;SDK 源码为准,文档与之矛盾即文档有误,需标注 SDK 的文件/行,不得反向修改源码迁就文档;并检查代码示例是否为当前 API、包名与模块路径是否正确、功能是否已弃用或移除、内部交叉链接是否可用。四,AI 可读性检查:页面是否自包含、关键上下文是否靠前、行内代码是否用反引号、术语是否符合术语锁定。五,可选竞品对比:仅对概念或操作指南类页面运行,通过 Web 访问获取 1–3 个相关对比页面并注明 URL 与访问日期,按覆盖度、深度、语气三个维度各给一条观察,竞品笔记用一行说明缺口;不模仿语气,只采纳结构或覆盖度,若竞品有不应效仿的做法也需注明。

输出:标题为“Docs Audit: [页面标题]”的报告,含 URL、内容类型、总体结论(Strong/Needs work/Significant gaps)、语气栈评估表格(各层评分与关键发现)、准确性问题、AI 可读性问题、优先修复建议,以及可选的竞品笔记。

限制:不改写页面(改写用 docs-writer)、不提交更改、不修改文档仓库。