SuperAPI AI 工具集

doc-adr-validator

通用与其它

查看项目

更新于 10-16 03:38

技能介绍

用途:在用户请求校验 ADR 文档,或创建、修改 ADR 产物后触发,依据 Layer 5 的 ADR_MVP_SCHEMA.yaml 对 ADR 进行合规校验。

主要能力:先做目录结构校验(阻塞项),要求 ADR 必须位于 docs/05_ADR/ADR-NN_{slug}/ 嵌套目录内,文件夹名与文件名需匹配 ADR ID,对应 ADR-E020、ADR-E021、ADR-E022 等错误码。随后校验元数据(document_type、artifact_type、layer、architecture_approaches、priority、development_status,及 adr、layer-5-artifact 标签与禁用标签)、结构(11 个必备章节:Document Control、Context、Decision、Alternatives Considered、Consequences、Architecture Flow、Implementation Assessment、Verification、Traceability、Related Decisions、MVP Lifecycle)、内容(状态值、Context/Decision/Consequences 子章节、Mermaid 图、ADR-Ready Score 最低 90%)与追溯(上游 @brd、@prd、@ears、@bdd 与 @related-adr、@supersedes、@depends-adr)。

使用方式:命令为 python ai_dev_ssd_flow/05_ADR/scripts/validate_adr.py docs/05_ADR/ADR-001_example.md(单文档)、python ai_dev_ssd_flow/05_ADR/scripts/validate_adr.py docs/05_ADR/(全部)及加 --verbose 的详细输出。校验流程从解析 YAML frontmatter 到生成报告,输出按严重级别列出错误、警告与提示,报告中含 Structure、Errors、Warnings、Info 等字段。

集成与适用场景:由 doc-flow、doc-adr(创建后)调用,可供 trace-check 做跨文档校验,并上报 quality-advisor;适用于 ADR 文档与模板的规范检查。

限制:仅覆盖资料列出的 ADR 规则与错误码;未提供价格、平台支持或性能等信息。