docs(architecture): add ADR template
This commit is contained in:
@@ -0,0 +1,62 @@
|
|||||||
|
# ADR-XXXX:<决策标题>
|
||||||
|
|
||||||
|
- 状态:Proposed | Accepted | Deprecated | Superseded
|
||||||
|
- 日期:YYYY-MM-DD
|
||||||
|
- 决策人:<团队/人员>
|
||||||
|
- 关联需求:<Issue/PR/文档链接>
|
||||||
|
|
||||||
|
## 背景
|
||||||
|
|
||||||
|
描述当前问题、约束条件,以及为什么现在必须做出这项决策。
|
||||||
|
|
||||||
|
## 决策驱动因素
|
||||||
|
|
||||||
|
- <驱动因素 1>
|
||||||
|
- <驱动因素 2>
|
||||||
|
- <驱动因素 3>
|
||||||
|
|
||||||
|
## 可选方案
|
||||||
|
|
||||||
|
1. <方案 A>
|
||||||
|
2. <方案 B>
|
||||||
|
3. <方案 C>
|
||||||
|
|
||||||
|
## 最终决策
|
||||||
|
|
||||||
|
选择方案:**<方案 X>**
|
||||||
|
|
||||||
|
说明选择该方案的理由,以及未选择其他方案的原因。
|
||||||
|
|
||||||
|
## 影响评估
|
||||||
|
|
||||||
|
### 正向影响
|
||||||
|
|
||||||
|
- <收益 1>
|
||||||
|
- <收益 2>
|
||||||
|
|
||||||
|
### 负向影响 / 取舍
|
||||||
|
|
||||||
|
- <代价 1>
|
||||||
|
- <代价 2>
|
||||||
|
|
||||||
|
## 实施计划
|
||||||
|
|
||||||
|
1. <步骤 1>
|
||||||
|
2. <步骤 2>
|
||||||
|
3. <步骤 3>
|
||||||
|
|
||||||
|
## 回滚方案
|
||||||
|
|
||||||
|
说明当风险发生时,如何撤销或回退这项决策。
|
||||||
|
|
||||||
|
## 验证清单
|
||||||
|
|
||||||
|
- [ ] 单元测试
|
||||||
|
- [ ] 集成测试
|
||||||
|
- [ ] 性能检查
|
||||||
|
- [ ] 安全检查
|
||||||
|
|
||||||
|
## 参考资料
|
||||||
|
|
||||||
|
- <参考资料 1>
|
||||||
|
- <参考资料 2>
|
||||||
Reference in New Issue
Block a user