开发设计模板

开发设计模板

项目背景

说清楚为什么要做这件事

项目目标

说清楚做这件事的预期收益是什么

名词解释

对文档中出现新的或不常见的名词、概念或简略语给出定义和解释。

总体设计

简单概述如何做这个项目

概要设计

实现的功能
概要描述该模块要实现的功能，不需描述其它模块。如果项目已有MRD，可在此分层次分条目列出功能点及子功能点。如果没有MRD,需在此列出要实现的功能点及子功能点，并对每一个功能点进行详细说明。功能点之间的层级和关联关系要明晰。这里仅描述功能，不需要涉及实现方案、功能取舍等问题。
设计的性能指标
系统的性能目标需要分解到模块，在此描述系统对该模块的性能要求。建议分条列出量化的性能指标，比如响应时间、超时率、资源占用、运行周期等。不能模糊、有岐义、想当然。

覆盖范围

描述本次项目覆盖的范围，为了降低风险，建议项目上线前做好灰度范围控制

详细设计

详细说明对应模块具体的实现

流程图

整个项目的设计架构，对模块相关的实现流程和业务规则进行详细说明。描述实现流程时，建议采用流程图的方式，也可以采用伪码或文字描述。无论采取哪种方式，都要注意分支的完备性，特别是异常分支。如果有子模块，在此对子模块做简要说明，并在“6.7 各子模块设计”中做进一步的设计

各模块详细设计

对各个模块进行详细阐述，尽量明确到代码层级，达到设计文档交给第三个人也可以按照文档要求进行代码开发

自测

说清楚当前工程下自己需要自测的模块以及自测方法

自测模块

自测方式

风险评估及对其它模块/系统影响

说清楚实现当前设计存在什么已知风险

已知的或可预知的风险

在这里加上已经知道的或可能会发生的风险，包括技术、业务等方面。最好针对每个风险，列出相应的应对措施。

与其它模块/系统可能的影响

在详细设计中描述了该模块与其它模块的依赖关系。在这里描述这些依赖关系可能带来的影响。包括本模块对其它模块可能造成的影响以及其它模块可能给本模块造成的影响两个方面。

设计评审意见

设计评审意见，这里累计记录和跟踪该文档评审时发现的问题。

NO	问题描述	提出人	处理方式说明	状态
1	问题1描述	提出人1	好好处理	open
2
3

附件及参考资料

填写文档相关的附件或参考资料。若是不常变更的文档（比如调研报告），建议以对象方式插入到该文档中。如是经常变更的文档（比如接口文档），建议在此列出文件名即可

总结