用途:校验 CTR(Data Contracts)文档是否符合 Layer 8 schema 标准,可在用户请求校验 CTR 文档时,或创建/修改 CTR 产物后调用。
主要能力:
- 目录结构校验(BLOCKING):CTR 必须位于嵌套目录 docs/08_CTR/CTR-NN_{slug}/,文件夹名需匹配 CTR ID,且 .md 与 .yaml 同名文件同时存在。
- 元数据校验:检查 document_type、artifact_type、layer、architecture_approaches、priority、development_status 等 custom_fields,以及 ctr、layer-8-artifact 等必需标签,并检测禁用标签模式。
- 结构校验:要求双文件格式(.md + .yaml),12 个必需章节(Document Control、Context、Contract Definition、Requirements Satisfied、Interface Definition、Error Handling、Quality Attributes、Versioning Strategy、Examples、Verification、Traceability、References)及 2 个可选附录。
- 内容校验:状态值、通信模式、错误码格式 ^[A-Z_]+$、语义化版本 MAJOR.MINOR.PATCH,YAML 需为 OpenAPI 3.x 或 JSON Schema 且端点具备请求/响应 schema。
- 可追溯性校验:要求 @brd、@prd、@ears、@bdd、@adr、@sys、@req 等上游标签,以及 @related-ctr、@depends-ctr 同类引用。
使用方式: 校验单个文档:python ai_dev_flow/scripts/validate_ctr.py docs/08_CTR/CTR-001_example.md 校验全部:python ai_dev_flow/scripts/validate_ctr.py docs/08_CTR/ 详细输出:python ai_dev_flow/scripts/validate_ctr.py docs/08_CTR/ --verbose
适用场景:CTR 文档创建或修改后的质量校验,以及供 trace-check 跨文档校验使用。
限制:资料未提供收费、价格、平台支持范围等信息;校验依赖指定 schema 与脚本路径,错误码与严重级别以资料所列为准。