编写详细设计说明书

 

详细设计

项目开发流程中有很重要的一步是编写详细设计说明书。根据个人多年编写详细设计的经验对编写详细设计进行简单总结，希望对各位有所帮助，详细设计文档中涉及到的数据流程图、业务流程图、用例图、类图、界面原型图等用到画图工具的，以后如果有时间我会进行补充说明。

 

详细设计说明书的任务

详细设计的主要任务是设计每个模块的实现算法、所需的局部数据结构。

简单的说就是让一个程序员拿到你的详细设计就可以开发。

 

详细设计主要内容

一般包括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)         尚未解决的问题（此处写开发之前应该明确但暂时未明确的问题）

 

 

 

最后附加一个简单的详细设计目录，仅供参考

1     引言. 1

1.1     编写目的. 1

1.2     适用范围. 1

1.3     术语和缩写. 1

1.4     参考资料. 2

2     概述. 2

2.1     系统概述. 2

2.2     系统功能定义. 2

3     总体结构说明. 2

3.1     系统结构. 2

3.1.1     系统内外部关系图. 2

3.1.2     功能模块简要说明. 3

3.1.3     依赖的外部接口. 3

3.1.4     对外提供的接口. 3

3.2     模块程序构件结构图. 3

4     数据模型设计. 4

4.1     逻辑实体模型. 4

4.2     表结构（物理设计）. 7

4.2.1     表汇总. 7

4.2.2     数据字典. 10

4.2.31     权限控制模块明细表. 36

4.3     视图列表. 38

4.4     关系清单. 38

5     功能实现说明. 40

5.1     功能模块名称. 41

5.2.1     数据流程图. 81

5.2.2     实现说明. 84

5.2.3     业务流程图. 93

5.2.4     程序设计. 98

6     界面实现说明. 164

6.1     功能模块名称. 164

6.1.1     总体界面结构（业务操作区）说明. 164

6.1.2     模块1 164

6.1.3     模块2 165

 

评论

13 楼 百合杰 2018-01-19  

qhj1203 写道

求个权限，这么好的文章看不到啊！

楼主都弃了这个博客了吧 都好久没更新了

12 楼 百合杰 2018-01-19  

ycj573407106 写道

qhj1203 写道

求个权限，这么好的文章看不到啊！

11 楼 ycj573407106 2017-10-23  

qhj1203 写道

求个权限，这么好的文章看不到啊！

10 楼 qhj1203 2016-02-25  

求个权限，这么好的文章看不到啊！

9 楼 tzword 2014-03-04  

楼主，可否给个权限？

8 楼 Surmounting 2013-03-28  

knowyouknowme 写道

Surmounting 写道

确实是高人。我基本上就根据你的骨架做我这边单位的详细设计书格式模板了哦。
多谢多谢。祝您和您的孩子万事如意。

连男朋友都没有的人，N年后，我会向我孩子带你的好的~

话说，又是接近半年了。
据说我现在单位，一共只有一个女技术。

7 楼 maosijun 2013-01-16  

  求权限。 

6 楼 zjj425970007 2012-10-19  

刚好要用。。

5 楼 xhqgogogo 2012-10-17  

下面的连接进不去哦

4 楼 knowyouknowme 2012-08-02  

Surmounting 写道

确实是高人。我基本上就根据你的骨架做我这边单位的详细设计书格式模板了哦。
多谢多谢。祝您和您的孩子万事如意。

连男朋友都没有的人，N年后，我会向我孩子带你的好的~

3 楼 Surmounting 2012-07-26  

我今天应该就能做完。届时会发下载链接和日志，欢迎前来指教～

2 楼 Surmounting 2012-07-26  

确实是高人。我基本上就根据你的骨架做我这边单位的详细设计书格式模板了哦。
多谢多谢。祝您和您的孩子万事如意。

1 楼 Alexis_He 2012-01-11