详细设计说明书-模板范文
- 格式：doc
- 大小：496.00 KB
- 文档页数：12
4.1.2
画出该模块的中涉及到的所有类的详细类图，并标明它们之间的关系（关联、依赖、聚合、组合、泛化、实现）
此处画上类图，如：
4.1.3
对该模块下的各个子功能，用顺序图、或活动图、或带泳道的活动图，或伪码等方式设计其流程算法。如果为顺序图，或活动图或带泳道的活动图，要进行编号，并且按编号顺序对每个环节进行说明其过程（推荐使用顺序图或活动图，因为这些图你们的毕业设计可以用得上，而且比较实用，注意这些图上每个环节要加上编号）。基本格式如下：
14，OrderService类调用OrderDAO类的addOrder()函数完成添加。
15，OrderDAO类通过OrderVO类获得Order类的数据封装。
16，OrderDAO类将Interger值（代表添加成功与否的判断条件）返回给OrderService类。
17，OrderService类将Interger值（代表添加成功与否的判断条件）返回给OrderServlet类。
【对本文档的说明：
1、本文档是项目详细设计说明书的模板，主要作用是为书写详细设计说明书建立规范，在实际编写过程中可根据项目的规模对文档的内容进行增删。
2、本文档中深蓝色斜字体为说明性文字，黑色正常字体为需求规格说明书实际写作时必需部分。
软件总体设计（概要设计）阶段确定了软件的总体结构，确定了模块的划分、模块间的接口。而软件的详细设计是在概要设计的基础上确定每个软件模块的实现算法，详细设计所产生的详细设计说明书是进行软件编码的依据。本文档提供了详细设计说明书的通用模板，具体到每个项目时，可以根据项目的特性添加必要的部分。】
1
1.1
说明编写本文档的目的，并指出预期的读者。
1.2
这一部分需要给出如下说明：
1、本项目的名称或本项目所开发的系统的名称；
2、本项目的任务提出者、开发者、使用者（用户）、维护机构；
1.3
此处列出本文档中用到的专门术语的定义和外文首字母组词的原词组。可使用表格列出，如:
缩写、术语
解释
1.4
列出与本文档相关的参考资料，例如：
4.1
4.1.1
此处描述该模块包含的功能，以及各功能的描述。如：
本模块包含客户信息录入，客户信息修改，客户信息注销功能（注意，这里面不能出现“等”字样）。
客户信息录入：系统登记订票客户的信息，该功能为客户在第一次来办理业务时进行登记
客户信息修改：系统将根据客户要求，将系统中客户的信息进行修改
客户信息注销：对于无效的客户信息，进行注销，不再使用该信息。
例子：UserDaoproxy.java
Factory
工厂类：一个有意义的名字＋Factory。这个类是用来调用dao接口的。而dao接口通过其子类Proxy实例化。
例子：UserFactory.java
3
对系统的总体软件结构进行必要的描述，采用图表的方式表示出模块间的层次关系和调用关系，其详细程度必须达到在本设计说明书中出现的每个模块在图表中都有反映，以便开发人员能对系统有个整体的了解。
vo
值对象，其中存放的是每个JavaBean，其中JavaBean的命名是和数据库中的表名称是一一对应的。
dbc
一个有意义的名字+dbc其中的类是来操纵数据库的关闭和打开的
例子：DataΒιβλιοθήκη aseConnection.java
Action
模块名＋Action:是用来给servlet命名的
例子：LoginAction.java
1、本项目的经批准的计划任务书或合同、批文等；
2、属于本项目的其它相关文档，如相应的需求规格说明书、概要设计说明书等；
3、本文档中引用的书籍、文件、资料等，包括所需要的软件开发标准。
列出上述资料的名称、作者、发布日期和出版单位（如果是公司内部资料则在出版单位处注明“内部资料”）。
2
如下所示:
包名
命名规则
时序图展示内容说明：
1，OrderManager通过JSP页面进行CURD操作。
2，JSP页面通过post方式和控制器Servlet交互，提交订单查询请求。
3，OrderService类通过DBConnection类建立和数据库的连接。
4，OrderServlet调用OrderService类的queryOrder()函数进行查询。
用户界面名称
用户界面编号
隶属的子系统
相关模块名称
相关模块编号
简要说明
图5.1
6
附录用来提供为了文档维护方便而进行独立发行的信息（例如，图表，分类数据）。如果可能，在文档主体中需要相关数据的地方提供对文档的索引。另外，根据项目的具体情况，可以在附录中补充一些模板未要求的内容，例如对程序头文件的说明、对程序日志文件的说明等。为了便于处理，附录应按字母或数字顺序标记（A，B，或1，2，等..）
22，OrderService类调用OrderDAO类的delOrder()函数完成删除。
23，OrderDAO类通过OrderVO类获得Order类的数据封装。
24，OrderDAO类将Interger值（代表删除成功与否的判断条件）返回给OrderService类。
25，OrderService类将Interger值（代表删除成功与否的判断条件）返回给OrderServlet类。
在设计说明书中出现的每个模块必须编号，以便进行跟踪。模块编号采用层次编码规则，根据模块在系统中的层次来确定其编号，每个层次采用两位数字来表示模块或其上级模块在对应层次中的序号，例如：新增固定资产登记在系统中的层次为：财务管理－》固定资产管理－》新增固定资产管理，则其模块编号如下：，而同一层的固定资产盘亏的模块编号为：。
3.1
订单管理
模块名称
功能简述
订单管理
对订单的CURD
订单审核
对网上下单以及本地下单进行审核
库存订单查询
对库存订单进行查询，方便交接单生成
订单确认
对货物配送的订单进行确认等相关操作
交接单管理
模块名称
功能简述
交接单管理
对交接单的CURD
紧急订单的查询
对紧急订单或者待发订单进行查询，方便交接单生成
班次查询及加急班次设置
form
模块名＋ActionForm：是用来给servlet命名的
例子：LoginActionForm.java
dao
I+有意义的名字+DAO，因为dao包是用来定义接口的，在接口的命名中，在最前面是要加上一个字母“I”的。
包中定义的每一个接口的抽象方法，都是用来让Impl类和Proxy类来实现的。
4.1.4
此处画上XX功能2顺序图（或活动图，或带泳道的活动图或伪码）等，要求如上。
4.2
4.2.1
4.2.2
5
5.1
此处列出系统各用户界面的设计图，也可制作有关用户界面图集的附录参考。对于每个用户界面需给出用户界面的名称和编号以便建立和模块的对应关系。
5.2
说明用户界面和模块之间的关系，包括：用户界面名称、用户界面编号、隶属的子系统、相关模块名称、相关模块编号、简要说明，可以采用图5.1的表格形式：
18，OrderServlet调用disPatch()函数，将response返回给JSP页面。
19，JSP页面通过post方式和控制器Servlet交互，提交订单删除请求。
20，OrderService类通过DBConnection类建立和数据库的连接。
21，OrderServlet调用OrderService类的delOrder()函数进行删除。
26，OrderServlet调用disPatch()函数，将response返回给JSP页面。
附加说明：本时序图中并没有画出详细类图中的updateOrder()、querystoreOrder()、queryconfirmOrder()这三个功能，因其具体流程和上面描述的过程基本一致。updateOrder（）功能的流程可以复用addOrder（）功能的基本流程；querystoreOrder()、queryconfirmOrder()功能的流程都可以复用queryOrder（）功能的流程。
10，OrderServlet调用disPatch()函数，将response返回给JSP页面。
11，JSP页面通过post方式和控制器Servlet交互，提交订单添加请求。
12，OrderService类通过DBConnection类建立和数据库的连接。
13，OrderServlet调用OrderService类的addOrder()函数进行添加。
5，OrderService类调用OrderDAO类的quryOrder()函数完成查询。
6，OrderDAO类通过OrderVO类获得Order类的数据封装。
7，OrderDAO类调用PageHelp完成分页请求。
8，OrderDAO类将PageHelp对象返回给OrderService类。
9，OrderService类将PageHelp对象返回给OrderServlet类。
查询班次，绑定交接单，申请加急班次，处理紧急订单
3.2
对应总体设计中的模块结构图或层次图，或者画上包图
4
本章将分段对系统的每个模块的设计进行具体描述。以下的提纲是针对一般情况的。具体到每个项目，由于项目的任务不同（例如新研发的项目和在原系统的基础上作改进的项目）、使用的设计方法不同（结构化设计、面向对象设计）、采用的开发工具不同等原因，对每个模块进行描述时需要的要素可能有所不同，则可根据具体项目的需要对以下的提纲进行适当地调整。
例子：IUserDAO.java
Impl
有意义的名字+Impl：这是用来实现具体的增、删、改、查的操作的真实实现类，不负责数据库的关闭，且直接不会被servlet调用。
画出该模块的中涉及到的所有类的详细类图，并标明它们之间的关系（关联、依赖、聚合、组合、泛化、实现）
此处画上类图，如：
4.1.3
对该模块下的各个子功能，用顺序图、或活动图、或带泳道的活动图，或伪码等方式设计其流程算法。如果为顺序图，或活动图或带泳道的活动图，要进行编号，并且按编号顺序对每个环节进行说明其过程（推荐使用顺序图或活动图，因为这些图你们的毕业设计可以用得上，而且比较实用，注意这些图上每个环节要加上编号）。基本格式如下：
14，OrderService类调用OrderDAO类的addOrder()函数完成添加。
15，OrderDAO类通过OrderVO类获得Order类的数据封装。
16，OrderDAO类将Interger值（代表添加成功与否的判断条件）返回给OrderService类。
17，OrderService类将Interger值（代表添加成功与否的判断条件）返回给OrderServlet类。
【对本文档的说明：
1、本文档是项目详细设计说明书的模板，主要作用是为书写详细设计说明书建立规范，在实际编写过程中可根据项目的规模对文档的内容进行增删。
2、本文档中深蓝色斜字体为说明性文字，黑色正常字体为需求规格说明书实际写作时必需部分。
软件总体设计（概要设计）阶段确定了软件的总体结构，确定了模块的划分、模块间的接口。而软件的详细设计是在概要设计的基础上确定每个软件模块的实现算法，详细设计所产生的详细设计说明书是进行软件编码的依据。本文档提供了详细设计说明书的通用模板，具体到每个项目时，可以根据项目的特性添加必要的部分。】
1
1.1
说明编写本文档的目的，并指出预期的读者。
1.2
这一部分需要给出如下说明：
1、本项目的名称或本项目所开发的系统的名称；
2、本项目的任务提出者、开发者、使用者（用户）、维护机构；
1.3
此处列出本文档中用到的专门术语的定义和外文首字母组词的原词组。可使用表格列出，如:
缩写、术语
解释
1.4
列出与本文档相关的参考资料，例如：
4.1
4.1.1
此处描述该模块包含的功能，以及各功能的描述。如：
本模块包含客户信息录入，客户信息修改，客户信息注销功能（注意，这里面不能出现“等”字样）。
客户信息录入：系统登记订票客户的信息，该功能为客户在第一次来办理业务时进行登记
客户信息修改：系统将根据客户要求，将系统中客户的信息进行修改
客户信息注销：对于无效的客户信息，进行注销，不再使用该信息。
例子：UserDaoproxy.java
Factory
工厂类：一个有意义的名字＋Factory。这个类是用来调用dao接口的。而dao接口通过其子类Proxy实例化。
例子：UserFactory.java
3
对系统的总体软件结构进行必要的描述，采用图表的方式表示出模块间的层次关系和调用关系，其详细程度必须达到在本设计说明书中出现的每个模块在图表中都有反映，以便开发人员能对系统有个整体的了解。
vo
值对象，其中存放的是每个JavaBean，其中JavaBean的命名是和数据库中的表名称是一一对应的。
dbc
一个有意义的名字+dbc其中的类是来操纵数据库的关闭和打开的
例子：DataΒιβλιοθήκη aseConnection.java
Action
模块名＋Action:是用来给servlet命名的
例子：LoginAction.java
1、本项目的经批准的计划任务书或合同、批文等；
2、属于本项目的其它相关文档，如相应的需求规格说明书、概要设计说明书等；
3、本文档中引用的书籍、文件、资料等，包括所需要的软件开发标准。
列出上述资料的名称、作者、发布日期和出版单位（如果是公司内部资料则在出版单位处注明“内部资料”）。
2
如下所示:
包名
命名规则
时序图展示内容说明：
1，OrderManager通过JSP页面进行CURD操作。
2，JSP页面通过post方式和控制器Servlet交互，提交订单查询请求。
3，OrderService类通过DBConnection类建立和数据库的连接。
4，OrderServlet调用OrderService类的queryOrder()函数进行查询。
用户界面名称
用户界面编号
隶属的子系统
相关模块名称
相关模块编号
简要说明
图5.1
6
附录用来提供为了文档维护方便而进行独立发行的信息（例如，图表，分类数据）。如果可能，在文档主体中需要相关数据的地方提供对文档的索引。另外，根据项目的具体情况，可以在附录中补充一些模板未要求的内容，例如对程序头文件的说明、对程序日志文件的说明等。为了便于处理，附录应按字母或数字顺序标记（A，B，或1，2，等..）
22，OrderService类调用OrderDAO类的delOrder()函数完成删除。
23，OrderDAO类通过OrderVO类获得Order类的数据封装。
24，OrderDAO类将Interger值（代表删除成功与否的判断条件）返回给OrderService类。
25，OrderService类将Interger值（代表删除成功与否的判断条件）返回给OrderServlet类。
在设计说明书中出现的每个模块必须编号，以便进行跟踪。模块编号采用层次编码规则，根据模块在系统中的层次来确定其编号，每个层次采用两位数字来表示模块或其上级模块在对应层次中的序号，例如：新增固定资产登记在系统中的层次为：财务管理－》固定资产管理－》新增固定资产管理，则其模块编号如下：，而同一层的固定资产盘亏的模块编号为：。
3.1
订单管理
模块名称
功能简述
订单管理
对订单的CURD
订单审核
对网上下单以及本地下单进行审核
库存订单查询
对库存订单进行查询，方便交接单生成
订单确认
对货物配送的订单进行确认等相关操作
交接单管理
模块名称
功能简述
交接单管理
对交接单的CURD
紧急订单的查询
对紧急订单或者待发订单进行查询，方便交接单生成
班次查询及加急班次设置
form
模块名＋ActionForm：是用来给servlet命名的
例子：LoginActionForm.java
dao
I+有意义的名字+DAO，因为dao包是用来定义接口的，在接口的命名中，在最前面是要加上一个字母“I”的。
包中定义的每一个接口的抽象方法，都是用来让Impl类和Proxy类来实现的。
4.1.4
此处画上XX功能2顺序图（或活动图，或带泳道的活动图或伪码）等，要求如上。
4.2
4.2.1
4.2.2
5
5.1
此处列出系统各用户界面的设计图，也可制作有关用户界面图集的附录参考。对于每个用户界面需给出用户界面的名称和编号以便建立和模块的对应关系。
5.2
说明用户界面和模块之间的关系，包括：用户界面名称、用户界面编号、隶属的子系统、相关模块名称、相关模块编号、简要说明，可以采用图5.1的表格形式：
18，OrderServlet调用disPatch()函数，将response返回给JSP页面。
19，JSP页面通过post方式和控制器Servlet交互，提交订单删除请求。
20，OrderService类通过DBConnection类建立和数据库的连接。
21，OrderServlet调用OrderService类的delOrder()函数进行删除。
26，OrderServlet调用disPatch()函数，将response返回给JSP页面。
附加说明：本时序图中并没有画出详细类图中的updateOrder()、querystoreOrder()、queryconfirmOrder()这三个功能，因其具体流程和上面描述的过程基本一致。updateOrder（）功能的流程可以复用addOrder（）功能的基本流程；querystoreOrder()、queryconfirmOrder()功能的流程都可以复用queryOrder（）功能的流程。
10，OrderServlet调用disPatch()函数，将response返回给JSP页面。
11，JSP页面通过post方式和控制器Servlet交互，提交订单添加请求。
12，OrderService类通过DBConnection类建立和数据库的连接。
13，OrderServlet调用OrderService类的addOrder()函数进行添加。
5，OrderService类调用OrderDAO类的quryOrder()函数完成查询。
6，OrderDAO类通过OrderVO类获得Order类的数据封装。
7，OrderDAO类调用PageHelp完成分页请求。
8，OrderDAO类将PageHelp对象返回给OrderService类。
9，OrderService类将PageHelp对象返回给OrderServlet类。
查询班次，绑定交接单，申请加急班次，处理紧急订单
3.2
对应总体设计中的模块结构图或层次图，或者画上包图
4
本章将分段对系统的每个模块的设计进行具体描述。以下的提纲是针对一般情况的。具体到每个项目，由于项目的任务不同（例如新研发的项目和在原系统的基础上作改进的项目）、使用的设计方法不同（结构化设计、面向对象设计）、采用的开发工具不同等原因，对每个模块进行描述时需要的要素可能有所不同，则可根据具体项目的需要对以下的提纲进行适当地调整。
例子：IUserDAO.java
Impl
有意义的名字+Impl：这是用来实现具体的增、删、改、查的操作的真实实现类，不负责数据库的关闭，且直接不会被servlet调用。
