{ 项目名称 }

软件系统设计报告

版 本 历 史

 目 录

0. 文档介绍... 4

0.1 文档目的与范围... 4

0.2 读者对象... 4

0.3 参考文献... 4

0.4 术语与缩写解释... 4

1. 系统概述... 5

2. 设计约束... 5

3. 设计策略... 5

4. 系统总体结构... 5

5. 子系统N的结构与功能... 6

6. 开发环境的配置... 6

7. 运行环境的配置... 6

8. 测试环境的配置... 6

9. 其它... 6

0. 文档介绍

0.1 文档目的与范围

0.2 读者对象

 

0.3 参考文献

提示：列出本文档的所有参考文献（可以是非正式出版物），格式如下：

[标识符] 作者，文献名称，出版单位（或归属单位），日期

例如：

[AAA]作者，《立项建议书》，机构名称，日期

 [SPP-PROC-SD] SEPG，系统设计规范，机构名称，日期

0.4 术语与缩写解释

1. 系统概述

提示：（1）说明本系统“是什么”，（2）描述本系统的主要功能。

2. 设计约束

提示：

（1）需求约束。体系结构设计人员从需求文档（如《用户需求说明书》和《软件需求规格说明书》）中提取需求约束，例如：

²  本系统应当遵循的标准或规范

²  软件、硬件环境（包括运行环境和开发环境）的约束

²  接口/协议的约束

²  用户界面的约束

²  软件质量的约束，如正确性、健壮性、可靠性、效率（性能）、易用性、清晰性、安全性、可扩展性、兼容性、可移植性等等。

（2）隐含约束。有一些假设或依赖并没有在需求文档中明确指出，但可能会对系统设计产生影响，设计人员应当尽可能地在此处说明。例如对用户教育程度、计算机技能的一些假设或依赖，对支撑本系统的软件硬件的假设或依赖等。

3. 设计策略

提示：体系结构设计人员根据产品的需求与发展战略，确定设计策略（Design Strategy）。例如：

²  扩展策略。说明为了方便本系统在将来扩展功能，现在有什么措施。

²  复用策略。说明本系统在当前以及将来的复用策略。

²  折衷策略。说明当两个目标难以同时优化时如何折衷，例如“时－空”效率折衷，复杂性与实用性折衷。

 

 

4. 系统总体结构

提示：

（1）将系统分解为若干子系统，绘制物理图和逻辑图，说明各子系统的主要功能。

（2）说明“如何”以及“为什么”（how and why）如此分解系统。

（3）说明各子系统如何协调工作，从而实现原系统的功能。

 

5. 子系统N的结构与功能

提示：

（1）将子系统N分解为模块（Module），绘制逻辑图（如果物理图和逻辑图不一样的话，应当绘制物理图），说明各模块的主要功能。

（2）说明“如何”以及“为什么”（how and why）如此分解子系统N。

（3）说明各模块如何协调工作，从而实现子系统N的功能。

 

6. 开发环境的配置

提示：说明本系统应当在什么样的环境下开发，有什么强制要求和建议？

 

7. 运行环境的配置

提示：说明本系统应当在什么样的环境下运行，有什么强制要求和建议？

 

8. 测试环境的配置

提示：说明本系统应当在什么样的环境下测试，有什么强制要求和建议？

（1）一般地，单元测试、集成测试环境与开发环境相同。

（2）一般地，系统测试、验收测试环境与运行环境相同或相似（更加严格）。

9. 其它

 

第二篇：CMMI-工程-TS-详细设计说明书模板-V1.0

广州润衡软件连锁有限公司 详细设计说明书

计 书模板 详细设说明

详细设计说明书

前 言

详细设计说明书

目 录

第一章 导言................................................................................................................................................................. 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

第 I 页

详细设计说明书

文档类别使用对象

文档类别

本文档是软件系统详细设计说明书的模板，是详细设计说明书的书写标准及规范，是技术文档。

使用对象

该文档使用人员包括：

? 系统分析人员

? 系统设计人员

? 系统编码人员

? 系统测试人员

? 系统维护人员

第 1 页

详细设计说明书

第一章 导言

本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。

1.1 目的

本文档的目的旨在推动软件工程的规范化，使设计人员遵循统一的详细设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。

详细设计的详细程度，应达到可以编写程序的水平。

1.2 范围

本文档用于软件设计阶段的详细设计，它的上游（依据的基线）是概要设计说明书，它的下游是源程序清单及单元测试计划，并为单元测试报告提供测试依据。

软件详细设计的范围是：各子系统的公用模块实现设计、专用模块实现设计、存储过程实现设计、触发器实现设计、外部接口实现设计、部门角色授权设计、其它详细设计等。

按照三层结构（B/A/S）的布局，详细设计应从下面三个方面进行：

数据库服务器上的面向数据的设计：数据字典物理设计、基本表物理设计、中间表物理设计（报表设计）、临时表物理设计、视图物理设计、存储过程物理设计、触发器物理设计；

应用服务器上的面向业务逻辑的设计：接口数据设计、中间件设计、数据通讯传输设计、可视组件设计、非可视组件设计、角色授权设计、功能点设计（功能列表设计）；

浏览器上的面向对象的设计：录入修改界面设计、浏览查询界面设计、登录注册界面设计。

1.3 术语定义

第 2 页

详细设计说明书

1.4 相关文档

1. 源程序清单

2. 单元测试计划及报告

3. 用户使用手册

1.5 参考资料

1. 软件需求规格说明书

2. 概要设计说明书

3. 软件合同

4. 命名规范

第 3 页

详细设计说明书

第二章 功能模块实现设计

详细设计是面向模块的，或者说是面向部件（组件或构件）的，不是面向组织结构或部门单位的。一个组织或单位，根据角色的授权，可以挂上某些功能模块。若为C/S或B/A/S结构，则要说明该模块运行在哪一层上。

2.1 公用模块实现设计

公用模块的提取与设计特别重要，设计它的目的是为了复用，因此它直接影响到系统的详细设计、编程、运行的质量。公用模块设计包括如下内容：

1. 模块编号：按照命名规则，如：G-XXX，将此公用模板编号写上。

2. 模块名称：写上此公用模块的中文名。

3. 模块功能：详细列出此公用模块的所有功能。

4. 模块背景描述：对背景进行简单的描述。为什么需要此模块功能，其上下文环境。

涉及业务背景内容，与需求相结合。

5. 模块算法设计：用伪语言（例如：if…endif;case…endcase;do…enddo;…）详细描

述出此公用模块的算法，标准是使程序人员据此能顺利地书写程序。在算法设计

时，需要考虑下列问题：

调用参数的描述：表述参数的结构，入口出口说明。

操作对象的描述：该功能对哪些数据对象（档案）进行写操作，对哪些对象进行读操作，写

操作的对象列在哪些功能里用到。

特别引用的描述：对引用的公共资源、特殊引用的函数进行说明。

操作流程的描述：具体的操作步骤。描述操作步骤，简单的说明书内容。可用做黑盒测试的

依据。可以采用图形交互。

注意事项：实现该功能项需注意的问题。

6. 模块调用方法：详细列出不同的调用的方式、入口参数、出口参数、异常处理。 第 4 页

详细设计说明书

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 页

详细设计说明书

注意事项：实现该功能项需注意的问题。

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 页

详细设计说明书

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 页

详细设计说明书

第三章 外部接口实现设计

3.1 外部接口1实现设计

1. 接口中文名称：

2. 接口英文名称：

3. 接口内容与功能：详细描述接口的内容与功能，如实现数据传输或数据交换。

4. 接口硬件设施：详细描述接口的硬件设施，如交换机、传感器或输出设备。

5. 接口软件或中间件：详细描述接口软件或中间件的名称、功能、使用方法、生产

厂商。

6. 接口的数据结构：详细描述接口的数据结构，如文件结构、数据库表结构。这是

描述的重点之一。

7. 接口的传输频率（兆/秒）：定量说明每秒最大流量。

8. 接口带宽：定量说明带宽，如多少兆。

9. 接口协议：说明具体协议。

10. 接口程序的算法分析：这是重点之二，要求用形式语言描述具体算法，使编码人

员据此能顺利书写程序。

3.2 外部接口2实现设计

1. 接口中文名称：

2. 接口英文名称：

3. 接口内容与功能：详细描述接口的内容与功能，如实现数据传输或数据交换。

4. 接口硬件设施：详细描述接口的硬件设施，如交换机、传感器或输出设备。 第 8 页

详细设计说明书

5. 接口软件或中间件：详细描述接口软件或中间件的名称、功能、使用方法、生产

厂商。

6. 接口的数据结构：详细描述接口的数据结构，如文件结构、数据库表结构。这是

描述的重点之一。

7. 接口的传输频率（兆/秒）：定量说明每秒最大流量。

8. 接口带宽：定量说明带宽，如多少兆。

9. 接口协议：说明具体协议。

10. 接口程序的算法分析：这是重点之二，要求用形式语言描述具体算法，使编码人

员据此能顺利书写程序。

第 9 页

详细设计说明书

第四章 其它实现设计

本章描述前面没有说明的设计。如部门角色授权设计、 界面设计、包装设计、维护设计、数据仓库设计等等。

4.1 部门角色授权设计

授权表的横坐标表示角色(部件、单位或岗位)，纵坐标表示功能模块，“●”表示授权。该授权表是工作站上菜单设计的依据。

4.2 其它详细设计

根据需要进行设计。

第五章 程序文件清单

主要描述的内容：子系统名、程序文件名、运行平台、简要描述

第 10 页