DSH VERTICAL KIT · 架构决策记录检查 / ADR 检查
架构决策记录检查清单
它决定一件事:这份决策记录是否让后来人能重新评估它。
检查规则
| 规则 | 判定 |
|---|---|
empty | 记录为空 → error |
status-missing | 没有状态行(状态:已接受 / Status: accepted)→ error |
context-missing | 没有背景段 → error(没有约束,后人无法重新评估) |
decision-missing | 没有决定段 → error |
consequences-missing | 没有后果段 → error |
consequences-one-sided | 后果只有好处没有代价 → warn |
consequences-unlabelled | 后果不分好坏 → warn(读者分不清哪条是要接受的成本) |
alternatives-missing | 没有备选方案段 → warn(只写赢的那个) |
status-unknown / date-missing | 状态不在常见取值 / 没有日期 → warn |
用法
npx adr-check docs/adr/0007-postgres-sessions.md --jsonnpx adr-check - < adr.md
真实输入输出
输入
# ADR-0007 用 Postgres 存会话
## 背景
会话要跨实例共享。
## 决定
会话写入 Postgres。
## 后果
- 好处:多副本共享,重启不丢会话
- 好处:不再需要粘性会话$ adr-check adr-sample.md
error status-missing 第0行 没有状态行(认得:状态:已接受、Status: accepted)——不知道这条决策是否已生效。可取值:proposed/accepted/rejected/deprecated/superseded…
warn alternatives-missing 第0行 没有备选方案段(认得:## 备选、## Alternatives)——只写选中方案,读者无法知道当时有没有别的路
warn date-missing 第0行 没有日期(认得:2026-11-18)——决策的时间点决定了它的上下文
warn consequences-one-sided 第13行 后果段只有好处没有代价(缺:代价/缺点/风险/trade-off)——只写收益的 ADR 通常没真正权衡过
fail: 2 consequences, 1 errors, 3 warnings
出口码:1。输出为真实 CLI 运行的逐字结果,由测试与工具保持同步。
出口码:0 干净、1 有发现、2 用法或读文件错误。--json 输出机器可读结果。DSH 内同样的函数在 POST /adr-check/api({"text":"…"} 或 {"path":"…"}),面板与 CI 调同一实现。
这是清单,不是专业人士。合同检查不是法律意见,发票检查不判税务合规,listing 检查不判商业价值。每条发现都是文本里可判定的结构缺陷,带行号。
状态取值:proposed/accepted/rejected/deprecated/superseded(含中文同级词)。代价词:代价/缺点/劣势/风险/成本/trade-off/downside;好处词:好处/优点/优势/收益/benefit/upside。只验记录形状,不验决策对不对:背景是否漏了大家都知道的约束、备选是不是稻草人、代价是否被压低——这些只有后果本身会在后来揭晓。 · dsh-vertical-kit · 通用检查(哈希/引用/结构/表格/数字)在 dsh-verify-kit