SuperAPI AI 工具集

doc-sys-validator

编程与开发

查看项目

更新于 10-16 03:37

技能介绍

用途:校验系统需求(SYS)文档是否符合 Layer 6 模式标准(SYS_MVP_SCHEMA.yaml),可在用户请求校验 SYS 文档时或创建、修改 SYS 产物后调用。

主要能力:先做阻塞性目录结构检查,要求 SYS 必须位于嵌套目录 docs/06_SYS/SYS-NN_{slug}/,文件夹与文件名需匹配 SYS ID(错误码 SYS-E020、SYS-E021、SYS-E022);随后校验元数据字段、标签分类、15 个必需章节、Document Control 字段、需求编号格式(SYS.NN.01.SS)、质量属性三段格式与质量类别覆盖度、上游追溯标签(brd、prd、ears、bdd、adr 共 5 个)、文件名规范,并计算 REQ-Ready Score(阈值 90%)。错误码分 error、warning、info 三档,例如 SYS-E001、SYS-W006、SYS-I001。

使用方式:执行校验命令,例如 python ai_dev_ssd_flow/06_SYS/scripts/validate_sys.py docs/06_SYS/SYS-01_example/SYS-01_example.md;可对整个目录 docs/06_SYS/ 校验,或加 --verbose 输出详细信息。结果以 SYS Validation Report 呈现,含状态、质量属性覆盖度与分严重级别的问题列表。

集成:由 doc-flow、doc-sys 在创建后调用,输出供 trace-check 跨文档校验使用,并向 quality-advisor 汇报。另需按 IPLAN-004 校验实现计划上下文,如 --iplan > --ref > --prompt 优先级假设,计划与产物目标冲突应作为阻塞问题上报;不引入 docs-v2.0/00_REF 等旧回退路径。

限制:具体安装方式、依赖版本、价格与支持平台暂未提供。