文档编号： 200409291516 保密级别：
版本编号： Version1.0
软件开发文档
文档名称：详细设计说明书
项目名称：XXXXXXXXXX
项目负责人：XX XX
编写： 校对： 审核： 批准：
年___月___日 年___月___日 年___月___日 年___月___日
Xxxxx信息科技有限公司
2004年
详细设计说明书
修订历史记录
版本 1.0 日期 2004年 09月15日 AMD boss 修订者 XXX 说明 首次编写 （A-添加，U-修改，D-删除）
XXX科技有限公司 第I页
详细设计说明书
目录
1 导言 ............................................................................................................................................ 1
1.1 目的 .......................................................................................................................................................... 1 1.2 范围 .......................................................................................................................................................... 1 1.3 术语定义 .................................................................................................................................................. 1 1.4 参考资料 .................................................................................................................................................. 2 1.5 相关文档 .................................................................................................................................................. 2 1.6 版本更新记录 .......................................................................................................................................... 2
2 模块实现设计 ............................................................................................................................ 2
2.1 公用模块设计 .......................................................................................................................................... 3 2.2 专用模块设计 .......................................................................................................................................... 3 2.3 存储过程设计 .......................................................................................................................................... 4 2.4 触发器设计 .............................................................................................................................................. 4
3 接口实现设计 ............................................................................................................................ 5 4 其他实现设计 ............................................................................................................................ 6
4.1 角色授权设计 .......................................................................................................................................... 6 4.2 其他详细设计 .......................................................................................................................................... 6
5 详细设计检查列表 .................................................................................................................... 6
5.1 功能设计检查列表 .................................................................................................................................. 7 5.2 性能设计检查列表 .................................................................................................................................. 7 5.3 接口设计检查列表 .................................................................................................................................. 7
XXX科技有限公司 第I页
详细设计说明书
1 导言
本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。
1.1 目的
本文档的目旨在推动软件工程的规范化，使设计人员遵循统一的详细设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。详细设计的详细程度，应达到可以编写程序的程度。
1.2 范围
本文档用于软件设计阶段的详细设计，它的上游（依据的基线）是《概要设计说明书》，它的下游是源程序清单及单元测试计划，并为单元测试报告提供测试依据。该范围应覆盖《概要设计说明书》中的功能点列表、性能点列表、接口列表。
软件详细设计的范围是：各子系统的公用模块实现设计、专用模块实现设计、存储过程实现设计、触发器实现设计、外部接口实现设计、部门角色授权设计、其他详细设计等。
按照3层结构（B/A/S）的布局，详细设计应从下面3个方面进行。数据库服务器上的面向数据的设计：数据字典物理设计、基本表物理设计、中间表物理设计（报表设计）、临时表物理设计、视图物理设计、存储过程物理设计、触发器物理设计。应用服务器上的面向业务逻辑的设计：接口数据设计、中间件设计、数据通信传输设计、可视构件设计、非可视构件设计、角色授权设计、功能点设计（功能点列表设计）。浏览器上的面向对象的设计：录入修改界面设计、浏览查询界面设计、登录注册界面设计、信息发布界面设计。
1.3 术语定义
术语定义，如表6-16所示。
表6-16 术语定义
序号 术语名称 1 2 3 4 详细设计 存储过程 触发器 算法 术 语 定 义 在概要设计的基础上，对其功能模块或部件进行实现设计，使编程人员据此能顺利书写出程序代码 存放在数据库服务器上的一段程序，它能被其他程序调用，以完成对数据库表的某些规定操作 存放在数据库服务器上的一段程序，当触发条件满足时它就被执行，以完成对数据库表的某些规定操作 详细设计中实现某项功能的数据处理方法及处理流程 XXX科技有限公司 第1页
详细设计说明书
1.4 参考资料
[1] 《概要设计说明书》 [2] 《需求分析说明书》 [3] 《软件合同》 [4] 命名规范 [5] 程序设计规范 [6] 界面设计规范
1.5 相关文档
[1] 源程序清单
[2] 单元测试计划及报告 [3] 《用户使用手册》
1.6 版本更新记录
版本更新记录，如表6-17所示。
表6-17 版本更新记录
版本号 V1.0 V1.0.1 创建者 王某某 —— 创建日期 2009/01/01 —— 维护者 —— 王某某 维护日期 —— 2004/09/15 维护纪要 —— 功能维护 2 模块实现设计
功能模块包括：登录注册模块、信息发布模块、菜单模块、录入修改模块、查询统计模块、数据处理模块、报表输出模块、前台网站模块、后台处理模块、数据传输与接收模块等等。详细设计是面向模块的，或者说是面向部件（或构件）的，不是面向组织结构或部门单位的。一个组织或单位，根据角色的授权，可以挂上某些功能模块。若为C/S或B/A/S结构，则要说明该模块运行在哪一层上。
XXX科技有限公司 第2页
详细设计说明书
2.1 公用模块设计
公用模块的提取与设计特别重要，设计它的目的是为了复用，因此它直接影响到系统的详细设计、编程、运行的质量。每个公用模块的设计要包括如下内容：
（1）模块编号：按照命名规则，如：G-XXX，将此公用模块编号写上。 （2）模块名称：此公用模块的英文名。
（3）模块功能：详细列出此公用模块的所有功能。
（4）模块背景描述：对背景进行简单的描述。为什么需要此模块功能，其上下文环境。涉及业务背景内容，与需求相结合。
（5）模块算法设计：用伪语言（例如，if…endif，case…endcase， do…enddo，…）详细描述出此公用模块的算法，标准是使程序人员据此能顺利地书写程序。
（6）模块调用方法：详细列出调用的方式、入口参数、出口参数、异常处理。 （7）模块编写者：编写者姓名。
（8）模块编写日期：编写日期：yyyy/mm/dd。 （9）模块修订者：修订者姓名。
（10）模块修订日期：修订日期：yyyy/mm/dd。 （11）模块测试者：测试者姓名。
（12）模块测试日期：测试日期：yyyy/mm/dd。
2.2 专用模块设计
非公用模块是为了处理一些特殊需求，它不可复用，每个非公用模块设计包括如下内容：
（1）模块编号：按照命名规则，如：M1-XXX，将此专用模块编号写上。 （2）模块名称：此模块的中文名。
（3）模块功能：详细列出此模块的所有功能。
（4）模块背景描述：对背景进行简单的描述。为什么需要此模块功能，其上下文环境。涉及业务背景内容，与需求相结合。
XXX科技有限公司 第3页
详细设计说明书
（5）模块算法设计：用伪语言（例如，if…endif，case…endcase， do…enddo，…）详细描述出此专用模块的算法，标准是使程序人员据此能顺利地书写程序。
（6）模块编写者：编写者姓名。
（7）模块编写日期：编写日期：yyyy/mm/dd。 （8）模块修订者：修订者姓名。
（9）模块修订日期：修订日期：yyyy/mm/dd。 （10）模块测试者：测试者姓名。
（11）模块测试日期：测试日期：yyyy/mm/dd。
2.3 存储过程设计
存储过程是一种特殊的公用模块，它在数据库服务器上执行，这里将它单独列出来，规定其详细设计模板为：
（1）存储过程中文名：此存储过程的中文名。 （2）存储过程英文名：此存储过程的英文名。 （3）存储过程功能: 详细描述其功能。
（4）存储过程算法: 用伪语言详细描述其算法，使编程人员据此能顺利书写程序。 （5）存储过程调用方式：详细列出调用的方式、入口参数、出口参数、异常处理。 （6）模块编写者：编写者姓名。
（7）模块编写日期：编写日期：yyyy/mm/dd。 （8）模块修订者：修订者姓名。
（9）模块修订日期：修订日期：yyyy/mm/dd。 （10）模块测试者：测试者姓名。
（11）模块测试日期：测试日期：yyyy/mm/dd。
2.4 触发器设计
触发器也是一种公用模块，不过它是隐式执行，这里将它单独列出来，规定其详细设计模板为：
（1）触发器中文名：此触发器的中文名。
XXX科技有限公司 第4页
详细设计说明书
（2）触发器英文名：此触发器的英文名。 （3）触发器功能：详细描述其功能。
（4）触发器算法：用伪语言详细描述其算法，使编程人员据此能顺利书写程序。 （5）触发器激活条件：详细描述其激活条件，使编辑人员据此能顺利书写程序。 （6）触发器编写者：编写者姓名。
（7）触发器编写日期：编写日期：yyyy/mm/dd。 （8）触发器修订者：修订者姓名。
（9）触发器修订日期：修订日期：yyyy/mm/dd。 （10）触发器测试者：测试者姓名。
（11）触发器测试日期：测试日期：yyyy/mm/dd。
注意：过多地使用触发器反而会使系统的效率降低。因此，凡是能用存储过程代替触发器功能的地方，一律用存储过程来实现。
3 接口实现设计
每个外部接口实现模块的设计要包括如下内容： （1）接口中文名称：此接口的中文名。 （2）接口英文名称：此接口的英文名。
（3）接口内容与功能：详细描述接口的内容与功能，如实现数据传输或数据交换。 （4）接口硬件设施：详细描述接口的硬件设施，如交换机、传感器或输出设备。 （5）接口软件或中间件：详细描述接口软件或中间件的名称、功能、使用方法、生产厂商。
（6）接口的数据结构：详细描述接口的数据结构，如文件结构、数据库表结构。 （7）接口的传输速率（Mbps）：定量说明每秒最大流量。 （8）接口带宽：定量说明带宽，如XXMbps。 （9）接口协议：说明具体协议。
（10）接口程序的算法：用伪语言详细描述其算法，使编码人员据此能顺利书写程序。
XXX科技有限公司 第5页
详细设计说明书
（11）接口编写者：编写者姓名。
（12）接口编写日期：编写日期：yyyy/mm/dd。 （13）接口修订者：修订者姓名。
（14）接口修订日期：修订日期：yyyy/mm/dd。 （15）接口测试者：测试者姓名。
（16）接口测试日期：测试日期：yyyy/mm/dd。
4 其他实现设计
本章描述前面没有说明的设计。如部门角色授权设计、界面设计、包装设计、维护设计等。
4.1 角色授权设计
授权表的横坐标表示角色（部件、单位或岗位），纵坐标表示功能模块，“●”表示授权。该授权表是工作站上菜单设计的依据，如表6-18所示。
表6-18 角色授权设计
模块名 模块英文名1 模块英文名2 模块英文名3 模块英文名4 模块英文名5 模块英文名6 模块英文名7 模块英文名8 … 角色1 ● ● ● 角色2 ● ● ● ● 角色3 ● ● ● ● 角色4 ● ● ● 角色5 ● ● ● ● 4.2 其他详细设计
根据需要进行设计。如界面设计、包装设计、维护设计等。
5 详细设计检查列表
按照概要设计文档的功能、性能和接口3个列表，设计出详细设计检查列表，以检查详细设计是否覆盖概要，没有覆盖就是不符合项，并将检查结果列出。
XXX科技有限公司 第6页
详细设计说明书
5.1 功能设计检查列表
功能设计检查列表，如表6-19所示。
表6-19 功能设计检查列表
编号 1 2 3 功能名称 使用部门 使用岗位 功能描述 输入内容 系统响应 输出内容 是否实现 5.2 性能设计检查列表
性能设计检查列表，如表6-20所示。
表6-20 性能设计检查列表
编号 1 2 3 性能名称 使用部门 使用岗位 性能描述 输入内容 系统响应 输出内容 是否实现 5.3 接口设计检查列表
接口设计检查列表，如表6-21所示。
表6-21 接口设计检查列表
编号 1 2 3 接口名称 接口规范 接口标准 入口参数 出口参数 传输频率 是否实现
XXX科技有限公司 第7页
因篇幅问题不能全部显示，请点此查看更多更全内容