开发文档,是针对每个开发需求而编写的文档,用来说明需求的背景、需求的实现思路,并记录这个需求所产生的接口文档、模板文档、数据库变更、上线待办清单、开发分支、注意事项等,方便在开发、联调、测试、上线过程中有很好的文档支撑,提高协同效率,提升系统稳定性。
一、基础
开发文档,是针对每个开发需求而编写的文档,用来说明需求的背景、需求的实现思路,并记录这个需求所产生的接口文档、模板文档、数据库变更、上线待办清单、开发分支、注意事项等,方便在开发、联调、测试、上线过程中有很好的文档支撑,提高协同效率,提升系统稳定性。如果需求有依赖底层或第三方的接口,或者有外部调用我方,也应一并记录方便查阅。
二、如何
- 背景
- 开发人员
- 业务背景
- 技术背景
- 需求分析
- 业务痛点
- 性能需求
- 方案描述
- 方案一
- 方案二
- 线上方案
- 异常边界
- 统计与监控
- 灰度&回滚
- 关键点&设计述求
- 部署扩展
- 风险评估