ADR-[编号]:[决策标题]
状态:[提议中 / 已接受 / 已废弃 / 已被 ADR-XXX 取代] 日期:[YYYY-MM-DD] 决策者:[姓名或团队]
背景
[用 2-5 句话描述:为什么需要做这个决策?面临什么问题或需求?]
决策
[用 1-3 句话明确说明:我们决定做什么。]
原因
主要理由:
- [理由 1]
- [理由 2]
考虑过的替代方案:
| 方案 | 优点 | 缺点 | 为什么不选 |
|---|---|---|---|
| [方案 A] | [优点] | [缺点] | [原因] |
后果
正面影响
- [正面结果 1]
负面影响 / 权衡
- [需要接受的代价或限制]
实施要求
- [需要做的具体工作,如更新文档、添加 lint 规则等]
ADR 编写指南:保持简短(目标 ≤ 30 行内容),重点是"为什么",而不是"怎么做"。