架构决策记录(ADR)
架构决策记录(ADR)
重大架构变更必须留下 ADR,记录决策背景、决策内容、替代方案和迁移影响(见 AGENTS.md「代码评审与演进」)。
约定
- 文件名
NNNN-<short-title>.md,四位编号单调递增、永不复用。 - 已接受的 ADR 不修改正文;决策被推翻时新增一条 ADR,并把旧条目 Status 改为
Superseded by NNNN。 - Status 取值:
Proposed、Accepted、Deprecated、Superseded by NNNN。
ADR 清单
新增 ADR 的步骤
- 复制现有 ADR 的结构,使用下一个可用编号。
- 在正文中链接触发该决策的实施计划或设计规格。
- 执行
python3 scripts/gen_doc_index.py重新生成本索引。