细 第 I 页
书模板 详设计说明
目 录
第一章 导言................................................................................................................................................................. 2 1.1 目的 ................................................................................................................................................................... 2 1.2 范围 ................................................................................................................................................................... 2 1.3 术语定义 ........................................................................................................................................................... 2 1.4 相关文档 ........................................................................................................................................................... 3 1.5 参考资料 ........................................................................................................................................................... 3 第二章 功能模块实现设计 ......................................................................................................................................... 4 2.1 公用模块实现设计 ........................................................................................................................................... 4 2.2 专用模块实现设计 ........................................................................................................................................... 5 2.3 过程实存储现设计 ........................................................................................................................................... 6 2.4 触发器实现设计 ............................................................................................................................................... 7 第三章 外部接口实现设计 ......................................................................................................................................... 8 3.1 外部接口1实现设计 ....................................................................................................................................... 8 3.2 外部接口2实现设计 ....................................................................................................................................... 8 第四章 其它实现设计 ............................................................................................................................................... 10 4.1 部门角色授权设计 ......................................................................................................................................... 10 4.2 其它详细设计 ................................................................................................................................................. 10 第五章 程序文件清单 ............................................................................................................................................... 10
第 II 页
详细设计说明书模板-V2.0
文档类别使用对象
文档类别
本文档是软件系统详细设计说明书的模板，是详细设计说明书的书写标准及规范，是技术文档。 使用对象
该文档使用人员包括：
系统分析人员 系统设计人员 系统编码人员 系统测试人员 系统维护人员
第 1 页
详细设计说明书模板-V2.0
第一章 导言
本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。
1.1 目的
本文档的目的旨在推动软件工程的规范化，使设计人员遵循统一的详细设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。
详细设计的详细程度，应达到可以编写程序的水平。
1.2 范围
本文档用于软件设计阶段的详细设计，它的上游（依据的基线）是概要设计说明书，它的下游是源程序清单及单元测试计划，并为单元测试报告提供测试依据。
软件详细设计的范围是：各子系统的公用模块实现设计、专用模块实现设计、存储过程实现设计、触发器实现设计、外部接口实现设计、部门角色授权设计、其它详细设计等。
按照三层结构（B/A/S）的布局，详细设计应从下面三个方面进行：
数据库服务器上的面向数据的设计：数据字典物理设计、基本表物理设计、中间表物理设计（报表设计）、临时表物理设计、视图物理设计、存储过程物理设计、触发器物理设计；
应用服务器上的面向业务逻辑的设计：接口数据设计、中间件设计、数据通讯传输设计、可视组件设计、非可视组件设计、角色授权设计、功能点设计（功能列表设计）；
浏览器上的面向对象的设计：录入修改界面设计、浏览查询界面设计、登录注册界面设计。
1.3 术语定义
序号 1 2 术语名称 术语定义 详细设计 在概要设计的基础上，对其功能模块或部件进行实现设计，使编程人员据此能顺利书写出程序代码。 存储过程 存放在数据库服务器上的一段程序，它能被其它程序调用，以完成对数据库表的某些规定操作。 第 2 页
详细设计说明书模板-V2.0
3 4
触发器 算法 存放在数据库服务器上的一段程序，当触发条件满足时它就被执行，以完成对数据库表的某些规定操作。 详细设计中实现某项功能的数据处理方法及处理流程。 1.4 相关文档
1. 源程序清单 2. 单元测试计划及报告 3. 用户使用手册
1.5 参考资料
1. 软件需求规格说明书 2. 概要设计说明书 3. 软件合同 4. 命名规范
第 3 页
详细设计说明书模板-V2.0
第二章 功能模块实现设计
详细设计是面向模块的，或者说是面向部件（组件或构件）的，不是面向组织结构或部门单位的。一个组织或单位，根据角色的授权，可以挂上某些功能模块。若为C/S或B/A/S结构，则要说明该模块运行在哪一层上。
2.1 公用模块实现设计
公用模块的提取与设计特别重要，设计它的目的是为了复用，因此它直接影响到系统的详细设计、编程、运行的质量。公用模块设计包括如下内容：
1. 模块编号：按照命名规则，如：G-XXX，将此公用模板编号写上。 2. 模块名称：写上此公用模块的中文名。 3. 模块功能：详细列出此公用模块的所有功能。
4. 模块背景描述：对背景进行简单的描述。为什么需要此模块功能，其上下文环境。
涉及业务背景内容，与需求相结合。
5. 模块算法设计：用伪语言（例如：if…endif;case…endcase;do…enddo;…）详细描
述出此公用模块的算法，标准是使程序人员据此能顺利地书写程序。在算法设计时，需要考虑下列问题：
调用参数的描述：表述参数的结构，入口出口说明。
操作对象的描述：该功能对哪些数据对象（档案）进行写操作，对哪些对象进行读操作，写操作的对象列在哪些功能里用到。
特别引用的描述：对引用的公共资源、特殊引用的函数进行说明。
操作流程的描述：具体的操作步骤。描述操作步骤，简单的说明书内容。可用做黑盒测试的依据。可以采用图形交互。
注意事项：实现该功能项需注意的问题。
6. 模块调用方法：详细列出不同的调用的方式、入口参数、出口参数、异常处理。 第 4 页
详细设计说明书模板-V2.0
7. 模块编写者： 写上编写者姓名。
8. 模块编写日期： 写上编写日期：yyyy/mm/dd。 9. 模块修订者：写上修订者姓名。
10. 模块修订日期：写上修订日期：yyyy/mm/dd。 11. 模块测试者：写上测试者姓名。
12. 模块测试日期：写上测试日期：yyyy/mm/dd。
13. 相关表结构设计：详细列出每个表的字段及其含义，并说明栏位的赋值及取值用
途。
2.2 专用模块实现设计
非公用模块是为了处理一些特殊需求，它不可复用，设计包括如下内容：
1. 块编号：按照命名规则，如：M1-XXX，将此公用模板编号写上。 2. 模块名称：写上此模块的中文名。 3. 模块功能：详细列出此模块的所有功能。
4. 模块背景描述：对背景进行简单的描述。为什么需要此模块功能，其上下文环境。
涉及业务背景内容，与需求相结合。
5. 模块算法设计：用伪语言（例如：if…endif;case…endcase;do…enddo;…）详细描
述出此公用模块的算法，标准是使程序人员据此能顺利地书写程序。在算法设计时，需要考虑下列问题：
输入输出的描述：表述模块的输入和输出。
操作对象的描述：该功能对哪些数据对象（档案）进行写操作，对哪些对象进行读操作，写操作的对象列在哪些功能里用到。
特别引用的描述：对引用的公共资源、特殊引用的函数进行说明。
操作流程的描述：具体的操作步骤。描述操作步骤，简单的说明书内容。可用做黑盒测试的依据。可以采用图形交互。
第 5 页
详细设计说明书模板-V2.0
注意事项：实现该功能项需注意的问题。
6. 模块编写者： 写上编写者姓名。
7. 模块编写日期： 写上编写日期：yyyy/mm/dd。 8. 模块修订者：写上修订者姓名。
9. 模块修订日期：写上修订日期：yyyy/mm/dd。 10. 模块测试者：写上测试者姓名。
11. 块测试日期：写上测试日期：yyyy/mm/dd。
12. 相关表结构设计：详细列出每个表的字段及其含义，并说明栏位的赋值及取值用
途。
2.3 存储过程实现设计
存储过程是一种特殊的公用模块，它在数据库服务器上执行，这里将它单独列出来，规定其详细设计模板为：
1. 存储过程中文名
2. 存储过程英文名（或拼音名）： 3. 存储过程功能: 详细描述其功能。
4. 存储过程算法: 用形式语言详细描述其算法分析，使编程人员据此能顺利书写程
序。
5. 存储过程调用方式： 6. 存储过程入口参数： 7. 存储过程出口参数
8. 模块编写者： 写上编写者姓名。
9. 模块编写日期： 写上编写日期：yyyy/mm/dd。 10. 模块修订者：写上修订者姓名。
11. 模块修订日期：写上修订日期：yyyy/mm/dd。 第 6 页
详细设计说明书模板-V2.0
12. 模块测试者：写上测试者姓名。
13. 模块测试日期：写上测试日期：yyyy/mm/dd。
2.4 触发器实现设计
触发器也是一种公用的模块，不过它是隐式执行，这里将它单独列出来，规定其详细设计模板为：
1. 触发器中文名:
2. 触发器英文名（或拼音名）： 3. 触发器功能: 详细描述其功能。
4. 触发器算法: 用形式语言详细描述其算法分析，使编程人员据此能顺利书写程序。 5. 触发器激活条件：
6. 触发器编写者： 写上编写者姓名。
7. 触发器编写日期： 写上编写日期：yyyy/mm/dd。 8. 触发器修订者：写上修订者姓名。
9. 触发器修订日期：写上修订日期：yyyy/mm/dd。 10. 触发器测试者：写上测试者姓名。
11. 触发器测试日期：写上测试日期：yyyy/mm/dd。
注意：过多地使用触发器反而会使系统的效率降低。因此，凡是能用存储过程代替触发器功能的地方，一律用存储过程来实现。
第 7 页
详细设计说明书模板-V2.0
第三章 外部接口实现设计
3.1 外部接口1实现设计
1. 接口中文名称： 2. 接口英文名称：
3. 接口内容与功能：详细描述接口的内容与功能，如实现数据传输或数据交换。 4. 接口硬件设施：详细描述接口的硬件设施，如交换机、传感器或输出设备。 5. 接口软件或中间件：详细描述接口软件或中间件的名称、功能、使用方法、生产
厂商。
6. 接口的数据结构：详细描述接口的数据结构，如文件结构、数据库表结构。这是
描述的重点之一。
7. 接口的传输频率（兆/秒）：定量说明每秒最大流量。 8. 接口带宽：定量说明带宽，如多少兆。 9. 接口协议：说明具体协议。
10. 接口程序的算法分析：这是重点之二，要求用形式语言描述具体算法，使编码人
员据此能顺利书写程序。
3.2 外部接口2实现设计
1. 接口中文名称： 2. 接口英文名称：
3. 接口内容与功能：详细描述接口的内容与功能，如实现数据传输或数据交换。 4. 接口硬件设施：详细描述接口的硬件设施，如交换机、传感器或输出设备。 第 8 页
详细设计说明书模板-V2.0
5. 接口软件或中间件：详细描述接口软件或中间件的名称、功能、使用方法、生产
厂商。
6. 接口的数据结构：详细描述接口的数据结构，如文件结构、数据库表结构。这是
描述的重点之一。
7. 接口的传输频率（兆/秒）：定量说明每秒最大流量。 8. 接口带宽：定量说明带宽，如多少兆。 9. 接口协议：说明具体协议。
10. 接口程序的算法分析：这是重点之二，要求用形式语言描述具体算法，使编码人
员据此能顺利书写程序。
第 9 页
详细设计说明书模板-V2.0
第四章 其它实现设计
本章描述前面没有说明的设计。如部门角色授权设计、 界面设计、包装设计、维护设计、数据仓库设计等等。
4.1 部门角色授权设计
授权表的横坐标表示角色(部件、单位或岗位)，纵坐标表示功能模块，“●”表示授权。该授权表是工作站上菜单设计的依据。
部门 模块 模块中文名1 模块英文名1 模块中文名2 模块英文名2 模块中文名3 模块英文名3 模块中文名4 模块英文名4 模块中文名5 模块英文名5 模块中文名6 模块英文名6 模块中文名7 模块英文名7 模块中文名8 模块英文名8 模块中文名9 模块英文名9
角色1 ● ● ● 角色2 ● ● ● ● 角色3 ● ● ● ● 角色4 ● ● ● 角色5 ● ● ● ● 4.2 其它详细设计
根据需要进行设计。
第五章 程序文件清单
主要描述的内容：子系统名、程序文件名、运行平台、简要描述
第 10 页