SuperAPI AI 工具集

doc-ears-reviewer

通用与其它

查看项目

更新于 10-16 03:36

技能介绍

用途:对 EARS(Easy Approach to Requirements Syntax)需求文档做深度内容审查,属于 EARS 质量保证层,在 BDD 生成前作为最终 QA 关卡。适用于 EARS 自动生成后、手工编辑后、运行 doc-bdd-autopilot 之前、周期性检查,以及 CI/CD 文档流水线中的自动审查门。若 EARS 尚不存在(先用 doc-ears 或 doc-ears-autopilot)、只需结构/模式校验(用 doc-ears-validator)或生成新内容时不适用。

主要能力:按检查项逐项审查——结构合规(嵌套文件夹规则,阻断式,需位于 docs/03_EARS/EARS-NN_{slug}/);EARS 语法合规(Ubiquitous、Event-Driven、State-Driven、Optional、Complex、Unwanted 六类模式,检查 SHALL 关键字、WHEN 条件等);阈值量化(WITHIN 子句需具体数值与单位,禁止“快速”等模糊词);PRD 对齐(需求可追溯、无孤儿需求、特性 ID 一致);可测试性(可度量结果、通过/失败标准、边界与负例);占位符检测([TODO]、[TBD] 等);章节完整性;命名合规(元素 ID 形如 EARS.NN.xxxx,类型码 25、26,禁止 REQ-NNN 等旧式);上游漂移检测,用强制缓存 docs/03_EARS/.drift_cache.json 与 SHA-256 哈希比对 PRD 是否在 EARS 创建后被修改。

评分与阈值:各项加权合计满分 100,≥90 为 PASS,80–89 为 WARNING,<80 为 FAIL;结构检查为阻断项。审查报告按 EARS-NN.R_review_report_vNNN.md 命名并存于对应嵌套文件夹,自动递增版本并支持与上次评分对比。

使用方式:运行 /doc-ears-reviewer EARS-01、/doc-ears-reviewer docs/03_EARS/EARS-01_f1_iam.md 或 /doc-ears-reviewer all。哈希计算需实际执行 sha256sum <file_path> | cut -d' ' -f1,不接受占位值。

限制:报告文件的具体存放约定、漂移阈值天数(默认 7/30 天)等以项目配置为准;资料未提供官方收费、价格与平台信息。