为方便PM&测试&RD阅读详细设计文档,约定一下模版,以后都按照此模版进行填写内容,内容不限于此要求,但是必须都要有此内容,不确定的
可以写:待定
自己内部可以剪裁,主要是保证对业务需求有思考以及上线有步骤
1:背景介绍
可以是一句话
2:需求文档
需求wiki地址,需要留痕
3:解决方案
3.1:设计方案
详细设计方案
3.2:涉及接口
涉及的接口路径/地址
3.3:改动点
如果是改动旧接口,请无比填写改动点,风格不限,只要qa能知道你改动的内容就好 eg:改动点截图
4:sql
无则写无,建议使用代码块,可折叠,背景色是酷炫黑色
4.1 DDL
4.2 DML
5:apollo配置
| 环境 | key | val | 描述 |
|---|---|---|---|
6:网络配置
无则写无
7:上下游对接人
无则写无 不确定则写待定
| 业务方名称 | rd | qa | 备注 |
|---|---|---|---|
8:上线顺序
无则写无 不确定则写待定
| 步骤 | 业务方 | rd | qa | 备注 |
|---|---|---|---|---|
9:回滚顺序
无则写无
| 步骤 | 业务方 | rd | qa | 备注 |
|---|---|---|---|---|
10:计算规则
无则写无
11:评审通过时间
无需评审,填写无需评审
12:影响面
无则写无