SuperAPI AI 工具集

doc-ctr-reviewer

通用与其它

查看项目

更新于 10-16 03:36

技能介绍

用途:对 Data Contract(CTR)文档做内容级审查与质量保证,是生成 SPEC 前的最终 QA 关卡,位于 Layer 8。适用时机包括 CTR 生成后、手动修改 CTR 后、运行 doc-spec-autopilot 前、外部 API 变更时及定期检查;CTR 尚不存在或仅需结构校验时不适用。

主要能力:八个审查项——结构合规(强制嵌套文件夹,阻塞性)、双文件一致性、OpenAPI 3.x 合规、REQ 对齐、端点覆盖、安全定义、占位符检测(TODO/TBD)、命名合规,以及上游漂移检测。漂移检测使用强制缓存 docs/08_CTR/.drift_cache.json,通过三阶段算法与 SHA-256 哈希比对发现 REQ 文档变更,配置项含 drift_threshold_days 默认 7、critical_threshold_days 默认 30。

评分与用法:按各项权重累加满分 100,PASS ≥90、WARNING 80–89、FAIL <80。命令示例:/doc-ctr-reviewer CTR-03-001、/doc-ctr-reviewer docs/08_CTR/CTR-03-001_provider_api/、/doc-ctr-reviewer all。报告存放在 CTR 嵌套文件夹内,命名为 CTR-NN-SSS.R_review_report_vNNN.md,并自动递增版本、支持与前次评分对比。

限制:仅做审查与有限自动修复(同步、格式等内容问题),结构问题由 doc-ctr-validator 负责;不生成新 CTR 内容;哈希值须为真实 64 位十六进制,禁止占位值。具体收费、平台与安装方式资料未提供。