54 lines
1.0 KiB
Markdown
54 lines
1.0 KiB
Markdown
# docs/design/architecture — 架构设计
|
||
|
||
存放系统架构文档和架构决策记录（ADR）。
|
||
|
||
## 文档
|
||
|
||
| 文档 | 说明 |
|
||
|------|------|
|
||
| [总体架构设计](./总体架构设计.md) | 系统整体架构、分层设计、数据模型、仿真引擎、接口设计 |
|
||
|
||
## 架构决策记录（ADR）
|
||
|
||
当需要做出影响系统结构的重大技术决策时，请创建一条 ADR。
|
||
|
||
### 文件命名
|
||
|
||
```
|
||
ADR-<序号>-<标题>.md
|
||
```
|
||
|
||
### ADR 模板
|
||
|
||
```markdown
|
||
# ADR-001: [决策标题]
|
||
|
||
- **状态**：提议 / 已接受 / 已废弃 / 已替代
|
||
- **日期**：YYYY-MM-DD
|
||
- **决策者**：[姓名]
|
||
- **替代**：[如替代了之前的 ADR]
|
||
|
||
## 背景
|
||
|
||
> 为什么需要做这个决策？面临什么问题？
|
||
|
||
## 决策
|
||
|
||
> 我们决定做什么？
|
||
|
||
## 备选方案
|
||
|
||
| 方案 | 优点 | 缺点 |
|
||
|------|------|------|
|
||
| 方案 A | ... | ... |
|
||
| 方案 B | ... | ... |
|
||
|
||
## 后果
|
||
|
||
> 决策后带来的影响（好的和需要关注的）。
|
||
```
|
||
|
||
---
|
||
|
||
> 关于 ADR 的更多说明，见 [adr.github.io](https://adr.github.io/)
|