总框架
一、需求类开发设计文档模版
1、PRD链接
PRD文档链接
2、后端设计
1)流程图/代码逻辑描述
描述代码逻辑,要求清晰准确,尽量用图表描述
超过3人天工作量的需求必须有流程图
2)库表设计
涉及数据库的改动,包括但不限于DML、DDL、ER图等
3)配置设计
涉及配置的改动,如果分布式配置、MQ主题配置、数据字典配置等
4)接口设计
涉及接口的改动,一般用接口卡描述
接口地址 | /xxx/xxx/xxx/xxx | 说明 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
请求方式 | POST | |||||||||||||||||||||||||
请求参数说明 |
| |||||||||||||||||||||||||
请求实例 | {"lineDetailIds":[1],"lockFlag":0} | |||||||||||||||||||||||||
响应参数说明 |
| |||||||||||||||||||||||||
响应实例 | { |
3、前端设计
1)页面设计
涉及页面UI的改动
2)前端交互逻辑设计
涉及页面交互逻辑的改动
4、测试建议
1)测试建议
给出代码的影响范围及测试建议
2)是否影响性能
分析是否影响性能,如何影响,是否需要压测
5、工作量评估
1)前后端工时评估(分析、设计、编码、测试等工作量总和,单位小时)
开发设计:编码:自测的比例建议是5:2:3
应该在设计上多花时间,避免返工
角色 | 需求评审/缺陷分析(小时) | 开发设计(小时) | 编码(小时) | 自测与bug修复(小时) | 总工时(小时) |
---|---|---|---|---|---|
后端 | |||||
前端 |
2)前后端联调时间
给出前后端联调时间(如不需要联调可不写)
3)转测时间
给出转测时间,需注明日期和上午/下午
二、缺陷类开发设计文档
1、影响场景
描述缺陷产生的场景,以及缺陷的影响范围
2、原因分析
分析缺陷产生的原因,最好有截图举证
3、解决方案
描述解决方案,采取什么措施解决这个缺陷
涉及到数据库结构变化或者接口调整,需要重点澄清
4、测试建议
与需求类一样,这里不再赘述
5、工作量评估
与需求类一样,这里不再赘述
三、技改类开发设计文档
1、重构目标
明确需要重构的代码模块或功能;补充前端使用场景
2、重构版本
锚定重构的分支及版本
3、后端设计
1)现有流程图/代码逻辑描述
描述现有代码逻辑,要求清晰准确,尽量用图表描述
2)重构流程图/代码逻辑描述
描述重构代码逻辑,要求清晰准确,尽量用图表描述
3)优化项/改动点
对比重构前后的代码,列举出改进之处和优化之处
4)配置设计
涉及配置的改动
4、测试建议
与需求类一样,这里不再赘述
5、工作量评估
与需求类一样,这里不再赘述