SuperAPI AI 工具集

doc-req-validator

通用与其它

查看项目

更新于 10-16 03:38

技能介绍

用途:校验原子需求(REQ)文档是否符合 Layer 7 模式标准(模式文件为 ai_dev_ssd_flow/07_REQ/REQ_MVP_SCHEMA.yaml)。在用户要求验证 REQ 文档,或创建、修改 REQ 产出物后调用。

主要能力:先做目录结构校验(BLOCKING),要求文档位于嵌套目录 docs/07_REQ/REQ-NN_{slug}/ 下,且目录名、文件名与 REQ ID 一致;再做元数据校验(document_type、artifact_type、layer、architecture_approaches、priority、development_status 及 req、layer-7-artifact 标签,禁用若干标签模式);结构校验要求 11 个章节、单一 H1、标题格式 # REQ-NN: [RESOURCE_TYPE] Title 及 Document Control 必填字段;内容校验覆盖 SHALL/SHOULD/MAY 关键词、验收标准 AC-NNN(模板至少 15 条)、接口定义、数据模式与 SPEC-Ready 分数(阈值 90%);并校验 6 个上游累积标签及同类引用。

用法:使用仓库脚本执行校验,例如单文档 ./ai_dev_ssd_flow/07_REQ/scripts/validate_req_template.sh docs/07_REQ/REQ-001_example/REQ-001_example.md;批量 find docs/07_REQ -name "REQ-*.md" -exec ./ai_dev_ssd_flow/07_REQ/scripts/validate_req_template.sh {} ;;详细输出 python3 ai_dev_ssd_flow/07_REQ/scripts/validate_req_spec_readiness.py docs/07_REQ/REQ-001_example/REQ-001_example.md --verbose。工作流依次解析 YAML、检查元数据与标签、验证章节与 Document Control、检查接口/数据模式/异常目录、统计验收标准、校验上游引用、计算分数、核对命名并生成报告。

适用与集成:用于需求文档质量把关,被 doc-flow、doc-req 调用,结果输入 trace-check,并上报 quality-advisor。

限制:资料未提供安装方式、依赖环境、收费或平台信息;校验规则与错误码以资料所列 REQ-E001 至 REQ-W007 等为准。