69 lines
1.2 KiB
Markdown
69 lines
1.2 KiB
Markdown
# 决策记录(ADR)
|
||
|
||
## 什么是ADR?
|
||
|
||
架构决策记录(Architecture Decision Records)用于记录所有重要的架构和设计决策,包括:
|
||
- 决策背景(为什么需要做这个决策)
|
||
- 考虑的选项
|
||
- 选择的方案
|
||
- 选择的理由
|
||
- 后果和影响
|
||
|
||
## ADR格式
|
||
|
||
每个ADR文件命名:`ADR-{序号}-{简短标题}.md`
|
||
|
||
### 标准模板
|
||
|
||
```markdown
|
||
# ADR-{序号}: {决策标题}
|
||
|
||
**状态**:{已采纳|已拒绝|已替代|待定}
|
||
**日期**:YYYY-MM-DD
|
||
**决策者**:{姓名/角色}
|
||
|
||
## 上下文
|
||
|
||
为什么需要做这个决策?当前面临什么问题?
|
||
|
||
## 考虑的选项
|
||
|
||
### 选项1:{选项名称}
|
||
- 优点:
|
||
- 缺点:
|
||
|
||
### 选项2:{选项名称}
|
||
- 优点:
|
||
- 缺点:
|
||
|
||
## 决策
|
||
|
||
选择的方案:{选项名称}
|
||
|
||
## 理由
|
||
|
||
为什么选择这个方案?
|
||
|
||
## 后果
|
||
|
||
### 正面影响
|
||
-
|
||
|
||
### 负面影响
|
||
-
|
||
|
||
### 约束
|
||
-
|
||
|
||
## 相关决策
|
||
|
||
- ADR-{序号}:{相关决策}
|
||
```
|
||
|
||
## ADR列表
|
||
|
||
- [ADR-001: 事件系统设计](./ADR-001-事件系统设计.md)
|
||
- [ADR-002: 表结构Tab显示策略](./ADR-002-表结构Tab显示策略.md)
|
||
- [ADR-003: 右键菜单实现方案](./ADR-003-右键菜单实现方案.md)
|
||
|