aps-agent/docs/adr/0000-template.md

35 lines
977 B
Markdown
Raw Permalink Normal View History

# ADR-0000:<把决定写成一句话>
- **状态**:提议
- **日期**:YYYY-MM-DD
- **决策人**:
- **相关**:任务表 <编号>;设计文档 <章节>
## 背景
为什么现在必须做这个决定。说清约束:时间、人力、既有系统、外部依赖。不复述背景知识,只写"是什么逼着我们现在选"。
## 选项
| 选项 | 做法 | 代价 | 不选的理由 |
| --- | --- | --- | --- |
| A | | | |
| B | | | |
至少两条,代价要写实。只有一个选项的"决定"通常不是决定,是既成事实。
## 结论
选了哪个,一句话说清,再写一条最重要的理由。
## 影响
- **对代码**:哪些模块或目录按这个决定组织
- **对任务**:任务表里哪些条目因此调整、依赖怎么变
- **对文档**:哪些设计文档章节要同步
- **不这么做的后果**:如果反过来选会怎样
## 遗留
还没定的点,逐条写明责任人与时限。没有就写"无"。