SuperAPI AI 工具集

reviewing-user-guide

写作与研究

查看项目

更新于 10-16 05:01

技能介绍

用途:这是“产出/判定”成对的最终用户指南技能中的判定一半。适用于指南发布给用户前的验收判定、作为独立评审方判定他人刚写好的指南、对修订稿重新判定、以及审查已发布指南的版本化增量(amend,按 cond-9 做增量范围判定)。

主要能力:以固定12条可用性+准确性清单逐项判定通过或有缺口,清单与作者产出用同一套、编号一致,不新增私有条件。条件包括:目标覆盖(每个上游目标有且仅有一个面向任务的操作指南)、Diataxis 四种模式齐全且类型正确、最终用户功能/配置参考完整、步骤与产品实际行为及控件标签一致、步骤机械结构(编号、一步一动作、第二人称、祈使、任务式标题)、故障排查覆盖已知错误状态、目标读者可独立完成、假设与缺口已标明、amend 增量已扫除过期引用并更新修订历史、简明语言可读、可访问性(按比例)、可发现性/起步指引、按比例。

使用方式:先以目标读者视角通读全篇,收集传入的上游材料(depends_on,通常为功能规格、用户流程、线框图等);有用户流程时从中枚举用户目标,无则取自功能规格/PRD;不要假定一定有用户流程。然后逐条判定通过或缺口,记录缺口确切位置与缺失内容。最终输出一行唯一判定:VERDICT: approve 或 VERDICT: revise,随后列出发现;revise 时每条发现须写明失败条件编号、确切位置与修复方式。

限制:只判定,不撰写、修复或改写指南,由产出一方修订;不得为显得用力而要求非必要修改,也不得为迎合而放过真实缺口;不得重复惩罚同一缺陷(术语/可读性归 cond-10,导航/可发现性归 cond-12);参考指最终用户产品界面(功能、设置、CLI 命令),不评判是否遗漏 HTTP API 端点;不评判渲染后的帮助站点、像素对比度与焦点外观;模板/章节一致性不由本技能判定;开发者接入指南、API 参考、工程设计文档分别使用其他评审技能。资料未提供具体安装命令或收费信息。