SuperAPI AI 工具集

doc-adr

通用与其它

查看项目

更新于 10-16 03:03

技能介绍

用途:doc-adr 为一项架构决策生成 ADR,是 SDD 流程第 5 层,作为 PRD(Container)与 SPEC(Component)之间的决策桥梁,本身不是 C4 层级。上游为 EARS、BDD,下游为 SPEC → TDD → IPLAN → Code。每个 ADR 只对应一个决策,新决策新建 ADR-02、ADR-03 等,并用 @depends: ADR-NN 关联。

适用场景:BRD §8 / PRD §14 的架构议题需要记录决策时;在多种方案间选择技术、模式或集成方式时;为长期架构选择留存理由与后果时。若需从上游产物端到端生成,使用 doc-adr-autopilot;规划项目整体 ADR 集合用 adr-roadmap。

主要能力与结构:先用模板确认,再确认上游产物存在并检查 ID 冲突。ADR 状态为 Proposed → Accepted → Deprecated → Superseded,并跟踪 SPEC-Ready 分数(Proposed 70–89%,Accepted ≥90%)。正文含文档控制(第 1 节:状态、日期、决策者、作者、originating_topic、brd_reference、SPEC-Ready 分数、修订历史)以及 Context、Decision、Alternatives Considered、Consequences、Architecture Flow、Implementation Assessment、Verification、Traceability、Related Decisions 等 10 个编号节,外加 Glossary 与 Appendix。备选方案需在选定项之外列出 2–3 个被拒方案,并写明具体淘汰因素。

用法要点:确认选题与 PRD §14 对应;为该层预留下一个空闲 ADR-NN(两位,必要时扩展);每个 ADR 放在 docs/05_ADR/ADR-NN_{slug}/,正文可单体或按节拆分;完成后更新 docs/05_ADR/ADR-00_index.md,并一起提交。内部元素 ID 形如 ADR.NN.SS.xxxx;文档级引用用短横线 ADR-NN,自标签 @adr: ADR-NN,交叉链接用 @depends: ADR-NN、@discoverability: ADR-NN;必需上游标签为 @ears @bdd。不得使用 DEC-XXX、ALT-XXX、CON-XXX 等已移除模式。

校验与限制:该技能本身即校验器,无运行时代码;需核对 10 节齐全、恰一个决策、备选与后果完整、标签与 ID 合规、Accepted 时 SPEC-Ready ≥90。质量门为阻塞项,问题需修复并复查,无法修复则记录人工复核。ADR-REF 文档(经 doc-ref)为自由格式,豁免就绪分数、必需上游标签和质量门。资料未提供具体价格、平台支持范围等信息。