详细设计
项目开发流程中有很重要的一步是编写详细设计说明书。根据个人多年编写详细设计的经验对编写详细设计进行简单总结,希望对各位有所帮助,详细设计文档中涉及到的数据流程图、业务流程图、用例图、类图、界面原型图等用到画图工具的,以后如果有时间我会进行补充说明。
详细设计说明书的任务
详细设计的主要任务是设计每个模块的实现算法、所需的局部数据结构。
简单的说就是让一个程序员拿到你的详细设计就可以开发。
详细设计主要内容
一般包括6章
一、 引言
二、 概述
三、 总体结构说明
四、 数据模型设计
五、 功能实现说明
六、 界面说明
一、二、三章在这里就不再详述,具体项目具体描述;四五六章节可视具体情况组织在一起编写。
现在详细说一下第五章功能实现说明。
5 功能实现说明
5.1 功能模块名称
【功能概述、功能分解(结合用例图、表格进行说明)】
5.2.1 数据流程图
【数据流程图 并加以说明,一般用visio工具画,一定要屡清每个模块的数据流向,从哪儿到哪儿,做怎样处理等等】
5.2.2 业务流程图
【利用工具画出该模块的业务流程图,如果业务流程比较复杂要加以说明】
5.2.3 实现说明
备注:功能实现说明与界面说明合并为一章节的话,可以在这里贴出界面原型图片
【此部分一般包括四部分】
1、 功能定义
【对该功能进行概述】
2、 处理流程
【编写该模块的处理流程,要有条理的写出自己的处理思路】
3、 业务规则
【简单描述该模块是按照什么业务规则进行实现的,也可以说简单需求】
4、 其他说明
【其他说明】
5.2.4 程序设计
【此部分就涉及到伪代码的编写了,包含的内容比较多,是与实现代码编写最相近的一步,大概包括以下几部分内容】
1、 目标文件定义(结合类图、表格,展现该模块实现的设计框架,简单的说即要表明都有什么类,这些类的定义主要是为实现何种功能)
2、 功能定义(对每个类中每个方法加以说明)
a) 输入输出(最好以表格形式)
b) 程序描述(编写伪代码,体现设计思路,包括异常说明,日志处理等)
c) 接口定义
d) 尚未解决的问题(此处写开发之前应该明确但暂时未明确的问题)
最后附加一个简单的详细设计目录,仅供参考