广州润衡软件连锁有限公司详细设计说明书详细设计说明书模板
前言
目录
第一章导言 (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)
文档类别使用对象
文档类别
本文档是软件系统详细设计说明书的模板，是详细设计说明书的书写标准及规范，是技术文档。
使用对象
该文档使用人员包括：
●系统分析人员
●系统设计人员
●系统编码人员
●系统测试人员
●系统维护人员
第一章导言
本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。
1.1目的
本文档的目的旨在推动软件工程的规范化，使设计人员遵循统一的详细设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。
详细设计的详细程度，应达到可以编写程序的水平。
1.2范围
本文档用于软件设计阶段的详细设计，它的上游（依据的基线）是概要设计说明书，它的下游是源程序清单及单元测试计划，并为单元测试报告提供测试依据。
软件详细设计的范围是：各子系统的公用模块实现设计、专用模块实现设计、存储过程实现设计、触发器实现设计、外部接口实现设计、部门角色授权设计、其它详细设计等。
按照三层结构（B/A/S）的布局，详细设计应从下面三个方面进行：
数据库服务器上的面向数据的设计：数据字典物理设计、基本表物理设计、中间表物理设计（报表设计）、临时表物理设计、视图物理设计、存储过程物理设计、触发器物理设计；
应用服务器上的面向业务逻辑的设计：接口数据设计、中间件设计、数据通讯传输设计、可视组件设计、非可视组件设计、角色授权设计、功能点设计（功能列表设计）；
浏览器上的面向对象的设计：录入修改界面设计、浏览查询界面设计、登录注册界面设计。
1.3术语定义
1.4相关文档
1.源程序清单
2.单元测试计划及报告
3.用户使用手册
1.5参考资料
1.软件需求规格说明书
2.概要设计说明书
3.软件合同
4.命名规范
第二章功能模块实现设计
详细设计是面向模块的，或者说是面向部件（组件或构件）的，不是面向组织结构或部门单位的。一个组织或单位，根据角色的授权，可以挂上某些功能模块。若为C/S或B/A/S结构，则要说明该模块运行在哪一层上。
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。
13.相关表结构设计：详细列出每个表的字段及其含义，并说明栏位的赋值及取值用
途。
2.2专用模块实现设计
非公用模块是为了处理一些特殊需求，它不可复用，设计包括如下内容：
1.块编号：按照命名规则，如：M1-XXX，将此公用模板编号写上。
2.模块名称：写上此模块的中文名。
3.模块功能：详细列出此模块的所有功能。
4.模块背景描述：对背景进行简单的描述。为什么需要此模块功能，其上下文环境。
涉及业务背景内容，与需求相结合。
5.模块算法设计：用伪语言（例如：if…endif;case…endcase;do…enddo;…）详细描
述出此公用模块的算法，标准是使程序人员据此能顺利地书写程序。在算法设计
时，需要考虑下列问题：
输入输出的描述：表述模块的输入和输出。
操作对象的描述：该功能对哪些数据对象（档案）进行写操作，对哪些对象进行读操作，写操作的对象列在哪些功能里用到。
特别引用的描述：对引用的公共资源、特殊引用的函数进行说明。
操作流程的描述：具体的操作步骤。描述操作步骤，简单的说明书内容。可用做黑盒测试的依据。可以采用图形交互。
注意事项：实现该功能项需注意的问题。
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。
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。
注意：过多地使用触发器反而会使系统的效率降低。因此，凡是能用存储过程代替触发器功能的地方，一律用存储过程来实现。
第三章外部接口实现设计
3.1外部接口1实现设计
1.接口中文名称：
2.接口英文名称：
3.接口内容与功能：详细描述接口的内容与功能，如实现数据传输或数据交换。
4.接口硬件设施：详细描述接口的硬件设施，如交换机、传感器或输出设备。
5.接口软件或中间件：详细描述接口软件或中间件的名称、功能、使用方法、生产
厂商。
6.接口的数据结构：详细描述接口的数据结构，如文件结构、数据库表结构。这是
描述的重点之一。
7.接口的传输频率（兆/秒）：定量说明每秒最大流量。
8.接口带宽：定量说明带宽，如多少兆。
9.接口协议：说明具体协议。
10.接口程序的算法分析：这是重点之二，要求用形式语言描述具体算法，使编码人
员据此能顺利书写程序。
3.2外部接口2实现设计
1.接口中文名称：
2.接口英文名称：
3.接口内容与功能：详细描述接口的内容与功能，如实现数据传输或数据交换。
4.接口硬件设施：详细描述接口的硬件设施，如交换机、传感器或输出设备。
5.接口软件或中间件：详细描述接口软件或中间件的名称、功能、使用方法、生产
厂商。
6.接口的数据结构：详细描述接口的数据结构，如文件结构、数据库表结构。这是
描述的重点之一。
7.接口的传输频率（兆/秒）：定量说明每秒最大流量。
8.接口带宽：定量说明带宽，如多少兆。
9.接口协议：说明具体协议。
10.接口程序的算法分析：这是重点之二，要求用形式语言描述具体算法，使编码人
员据此能顺利书写程序。
第四章其它实现设计
本章描述前面没有说明的设计。如部门角色授权设计、界面设计、包装设计、维护设计、数据仓库设计等等。
4.1部门角色授权设计
授权表的横坐标表示角色(部件、单位或岗位)，纵坐标表示功能模块，“●”表示授权。该授权表是工作站上菜单设计的依据。
4.2其它详细设计
根据需要进行设计。
第五章程序文件清单
主要描述的内容：子系统名、程序文件名、运行平台、简要描述
软件详细设计说明书 v1.0 200X年月XX日 修订历史记录
编制 审查 审核 批准 文档评审负责人：参加评审人员：
目录 1引言 (4) 1.1编写目的 (4) 1.2背景 (4) 1.3定义 (4) 1.4设计依据 (4) 2软件系统结构 (4) 2.1功能需求 (4) 2.2子模块划分 (4) 2.3子模块间关系 (4) 3公共数据结构 (4) 4程序设计说明 (5) 4.1程序1设计说明 (5) 4.1.1程序描述 (5) 4.1.2功能 (5) 4.1.3性能 (5) 4.1.4输入 (5) 4.1.5输出 (5) 4.1.6算法 (5) 4.1.7流程 (5) 4.2程序2设计说明 (5) 5模块重用说明 (5)
1引言 1.1编写目的 〖说明编写这份软件详细设计说明书的目的〗 1.2背景 〖说明待开发软件（子）系统的名称和此软件（子）系统所属大系统的名称； 说明任务的来源（开发背景和市场背景）等；该软件（子）系统与大系统中其他子系统的关系。〗 1.3定义 〖列出本文档中所用到的专门术语的定义和缩写词的原意〗 1.4设计依据 〖列出本文档所引用的有关设计依据（标题、文件编号、版本号、作者、发布日期、出版单位），包括本项目内部已编写的有效文档、出版刊物和国家标准或规范〗2软件系统结构 2.1功能需求 2.2子模块划分 〖说明本软件系统(或模块)的实现，即其内部的子模块划分（给出程序的名称和标识符）。建议以图形说明。〗 1.XXXXXXXX 2.XXXXXXXX 3.XXXXXXXX 4.XXXXXXXX 5.XXXXXXXX 6.XXXXXXXX 2.3子模块间关系 〖说明各子模块间的控制、顺序等耦合关系。〗 3公共数据结构 〖给出本软件系统使用的每一个公共数据结构的类型定义、存储方式，公共数据结构内各元素项的类型定义、初始取值、可能取值的范围及相应的物理含义。建议以类似Ｃ语言的数据说明格式来描述。〗
（项目名称）详细设计说明书 文件版本 编写日期 发布日期
文件修改记录 修改日期版本号变化状态修改内容修改人 *变化状态：C――创建，A——增加，M——修改，D——删除 文档审批信息 版本号提交人批准人批准日期发布日期备注
目录 1引言 (1) 1.1编写目的 (1) 1.2适用范围 (1) 1.3术语和缩写 (1) 1.4参考资料 (1) 2概述 (1) 2.1系统概述 (1) 2.2系统功能定义 (1) 3总体结构说明 (1) 3.1系统结构 (1) 3.1.1系统内外部关系图 (1) 3.1.2功能模块简要说明 (1) 3.1.3依赖的外部接口 (1) 3.1.4对外提供的接口 (1) 3.2模块程序构件结构图 (1) 4数据模型（Data Model）设计 (2) 4.1逻辑实体模型 (2) 4.1.1实体模型1 (2) 4.1.2实体模型2 (3) 4.2表结构（物理设计） (3) 4.2.1表汇总 (3) 4.2.2表1 (3) 4.2.3表2 (3) 4.3视图列表 (4) 5功能实现说明 (4) 5.1数据流类模块 (4) 5.1.1数据流程图 (4) 5.1.2实现说明 (4) 5.1.3程序设计 (4) 5.2业务处理类模块 (5) 5.2.1Object Model设计 (5)
5.2.2程序设计 (5) 6界面实现说明 (5) 6.1模块1 (5) 6.1.1总体界面结构（业务操作区）说明 (5) 6.1.2功能点1界面结构说明 (5) 6.1.3功能点2界面结构说明 (5) 6.2模块2 (6) 6.2.1总体界面结构（业务操作区）说明 (6) 6.2.2功能点1界面结构说明 (6) 6.2.3功能点2界面结构说明 (6)
修订记录
目录 第一章概述........................................................................... 错误!未定义书签。 1.1.应用模块的目的....................................................... 错误!未定义书签。 1.2.应用模块总体描述................................................... 错误!未定义书签。 1.3.应用模块接口描述................................................... 错误!未定义书签。 1.4.假设条件................................................................... 错误!未定义书签。第二章设计模式（Design pattern） ................................... 错误!未定义书签。第三章类设计....................................................................... 错误!未定义书签。 3.1.分块类图................................................................... 错误!未定义书签。 <类图1> ............................................................ 错误!未定义书签。 <类图n> ............................................................ 错误!未定义书签。 3.2.整体继承关系........................................................... 错误!未定义书签。 3.3.类描述....................................................................... 错误!未定义书签。 <类名1> Class Description............................. 错误!未定义书签。 <类名n> Class Description............................. 错误!未定义书签。第四章交互图....................................................................... 错误!未定义书签。 4.1.<情景编号1: 情景名称> ........................................ 错误!未定义书签。 交互图................................................................ 错误!未定义书签。 例外情况及条件................................................ 错误!未定义书签。 4.2.<情景编号n: 情景名称> ........................................ 错误!未定义书签。第五章状态图....................................................................... 错误!未定义书签。 5.1.<状态图编号1:状态图名称> .................................. 错误!未定义书签。 5.2.<状态图编号n:状态图名称> .................................. 错误!未定义书签。第六章时序流程图............................................................... 错误!未定义书签。第七章用户界面设计说明................................................... 错误!未定义书签。 7.1.用户界面关系........................................................... 错误!未定义书签。 7.2.用户界面具体描述................................................... 错误!未定义书签。 <界面编号1:界面名称〉 ................................. 错误!未定义书签。 <界面编号N:界面名称〉 ................................ 错误!未定义书签。
XX项目 设计规格说明书 (仅供内部使用) 重庆工学院计算机学院 XX年XX月XX日
修改记录
目录 1．引言.................................... 错误!未定义书签。 项目名称.................................... 错误!未定义书签。 编写目的.................................... 错误!未定义书签。 项目背景.................................... 错误!未定义书签。 定义........................................ 错误!未定义书签。 参考资料.................................... 错误!未定义书签。2．任务概述..................................... 错误!未定义书签。 项目总体目标................................ 错误!未定义书签。 需求概述.................................... 错误!未定义书签。 运行环境.................................... 错误!未定义书签。 软件环境............................... 错误!未定义书签。 硬件环境............................... 错误!未定义书签。 开发环境.................................... 错误!未定义书签。 条件与限制.................................. 错误!未定义书签。3．总体设计..................................... 错误!未定义书签。 系统架构.................................... 错误!未定义书签。 处理流程.................................... 错误!未定义书签。4．功能详细设计................................. 错误!未定义书签。 功能1 ...................................... 错误!未定义书签。 功能说明............................... 错误!未定义书签。 功能结构............................... 错误!未定义书签。 类设计................................ 错误!未定义书签。 用户界面设计............................ 错误!未定义书签。 类1 的算法与程序逻辑.................. 错误!未定义书签。 方法1 .............................. 错误!未定义书签。 功能............................ 错误!未定义书签。 输入............................ 错误!未定义书签。
xxxxx系统详细设计说明书
版本历史
修改记录
目录 1引言 (5) 1.1编写目的 (5) 1.2背景 (5) 1.3参考资料 (5) 1.4术语定义及说明 (5) 2设计概述 (5) 2.1任务和目标 (5) 2.1.1需求概述 (5) 2.1.2运行环境概述 (5) 2.1.3条件与限制 (6) 2.1.4详细设计方法和工具 (6) 3系统详细需求分析 (6) 3.1详细需求分析 (6) 3.2详细系统运行环境及限制条件分析接口需求分析 (6) 4总体方案确认 (6) 4.1系统总体结构确认 (6) 4.2系统详细界面划分 (7) 4.2.1应用系统与支撑系统的详细界面划分 (7) 4.2.2系统内部详细界面划分 (7) 5系统详细设计 (7) 5.1系统程序代码架构设计 (7) 5.1.1UI(User Interface)用户界面表示层 (7) 5.1.2BLL(Business Logic Layer)业务逻辑层 (8) 5.1.3DAL(Data Access Layer)数据访问层 (8) 5.1.4Common类库 (8) 5.1.5Entity Class实体类 (8) 5.2系统结构设计及子系统划分 (8) 5.3系统功能模块详细设计 (9) 5.3.1XX子系统 (9) .1XX模块 (9) 列表和分页 (9) 创建XX (9) .2XX模块 (9) XX列表 (9) XX修改 (9) 5.3.2XX子系统 (9) 5.3.6.1用户管理模块 (9) 5.3.6.2角色管理模块 (14) 5.3.6.3系统设置模块 (14) 5.3.6.4系统登录注销模块 (14) 5.4系统界面详细设计 (14) 5.4.1外部界面设计 (14) 5.4.2内部界面设计 (14) 5.4.3用户界面设计 (14) 6数据库系统设计 (14) 6.1设计要求 (14) 6.2信息模型设计 (14) 6.3数据库设计 (14) 6.3.1设计依据 (14)
实用文案
修订记录
目录 第一章概述 (5) 1.1.应用模块的目的 (5) 1.2.应用模块总体描述 (5) 1.3.应用模块接口描述 (5) 1.4.假设条件 (5) 第二章设计模式（Design pattern） (6) 第三章类设计 (7) 3.1.分块类图 (8) 3.1.1.<类图1> 8 3.1.2.<类图n> 8 3.2.整体继承关系 (8) 3.3.类描述 (9) 3.3.1.<类名1> Class Description 9 3.3.2.<类名n> Class Description 10 第四章交互图 (12) 4.1.<情景编号1: 情景名称> (12) 4.1.1.交互图 12 4.1.2.例外情况及条件 13 4.2.<情景编号n: 情景名称> (13) 第五章状态图 (14) 5.1.<状态图编号1:状态图名称> (14)
5.2.<状态图编号n:状态图名称> (15) 第六章时序流程图 (16) 第七章用户界面设计说明 (18) 7.1.用户界面关系 (18) 7.2.用户界面具体描述 (18) 7.2.1.<界面编号1:界面名称〉 18 7.2.2.<界面编号N:界面名称〉 19 第八章测试考虑 (20) 第九章附录 (21) 9.1.附录A 代码举例 (21) 9.2.附录B 设计问题 (21) 9.2.1.<设计问题1> 21 9.2.2.<设计问题n> 21
第一章概述 1.1.应用模块的目的 请明确客户建立应用模块的目的。 1.2.应用模块总体描述 描述应用模块的总体功能。 1.3.应用模块接口描述 简要描述本应用模块的公共接口，具体接口会在相应的类中进行具体描述。建议采用列表的方式。 1.4.假设条件 列出在问题领域，项目方案及其它影响系统设计的可能方面内，应当成立的假设条件。包括系统的约束条件和应遵循的标准。
修订记录
目录 第一章概述 (5) 1.1. 应用模块的目的 (5) 1.2. 应用模块总体描述 (5) 1.3. 应用模块接口描述 (5) 1.4. 假设条件 (5) 第二章设计模式（Design pattern） (6) 第三章类设计 (7) 3.1. 分块类图 (8) 3.1.1. <类图1> (8) 3.1.2. <类图n> (8) 3.2. 整体继承关系 (8) 3.3. 类描述 (9) 3.3.1. <类名1> Class Description (9) 3.3.2. <类名n> Class Description (10) 第四章交互图 (12) 4.1. <情景编号1: 情景名称> (12) 4.1.1. 交互图 (12) 4.1.2. 例外情况及条件 (13) 4.2. <情景编号n: 情景名称> (13) 第五章状态图 (14) 5.1. <状态图编号1:状态图名称> (14)
5.2. <状态图编号n:状态图名称> (15) 第六章时序流程图 (16) 第七章用户界面设计说明 (18) 7.1. 用户界面关系 (18) 7.2. 用户界面具体描述 (18) 7.2.1. <界面编号1:界面名称〉 (18) 7.2.2. <界面编号N:界面名称〉 (19) 第八章测试考虑 (20) 第九章附录 (21) 9.1. 附录A 代码举例 (21) 9.2. 附录B 设计问题 (21) 9.2.1. <设计问题1> (21) 9.2.2. <设计问题n> (21)
第一章概述 1.1.应用模块的目的 请明确客户建立应用模块的目的。 1.2.应用模块总体描述 描述应用模块的总体功能。 1.3.应用模块接口描述 简要描述本应用模块的公共接口，具体接口会在相应的类中进行具体描述。建议采用列表的方式。 1.4.假设条件 列出在问题领域，项目方案及其它影响系统设计的可能方面内，应当成立的假设条件。包括系统的约束条件和应遵循的标准。
详细设计说明书 1．导言（Introduction） 本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。 1.1 目的（Purpose） 本文档的目旨在推动软件工程的规范化，使设计人员遵循统一的详细设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。详细设计的详细程度，应达到可以编写程序的程度。 1.2 范围（Scope） 本文档用于软件设计阶段的详细设计，它的上游（依据的基线）是《概要设计说明书》，它的下游是源程序清单及单元测试计划，并为单元测试报告提供测试依据。该范围应覆盖《概要设计说明书》中的功能点列表、性能点列表、接口列表。软件详细设计的范围是：各子系统的公用模块实现设计、专用模块实现设计、存储过程实现设计、触发器实现设计、外部接口实现设计、部门角色授权设计、其他详细设计等。 按照3层结构（B/A/S）的布局，详细设计应从下面3个方面进行。数据库服务器上的面向数据的设计：数据字典物理设计、基本表物理设计、中间表物理设计（报表设计）、临时表物理设计、视图物理设计、存储过程物理设计、触发器物理设计。应用服务器上的面向业务逻辑的设计：接口数据设计、中间件设计、数据通信传输设计、可视构件设计、非可视构件设计、角色授权设计、功能点设计（功能点列表设计）。浏览器上的面向对象的设计：录入修改界面设计、浏览查询界面设计、登录注册界面设计、信息发布界面设计。 1.3 术语定义（Terms Glossary） 术语定义，如表6-16所示。 表6-16 术语定义 1.4 参考资料（References） [1] 《概要设计说明书》 [2] 《需求分析说明书》 [3] 《软件合同》
XX银行XX项目总体设计说明书 一、总体设计 1．需求规定 说明对本系统的主要的输入输出项目、处理的功能性能要求。 2．运行环境 简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定。 3．基本设计概念和处理流程 说明本系统的基本设计概念和处理流程，尽量使用图表的形式。 4．结构 用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系。 5．功能需求与程序的关系 本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：
6．人工处理过程 说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。 7．尚未问决的问题 说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。 二、接口设计 1．用户接口 说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。 2．外部接口 说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。 3．内部接口 说明本系统之内的各个系统元素之间的接口的安排。
三、运行设计 1．运行模块组合 说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。 2．运行控制 说明每一种外界的运行控制的方式方法和操作步骤。3．运行时间 说明每种运行模块组合将占用各种资源的时间。 四、系统数据结构设计 1．逻辑结构设计要点 给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。 2．物理结构设计要点 给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。 3．数据结构与程序的关系 说明各个数据结构与访问这些数据结构的形式:
- 详细设计说明书的主要内容及写作要求 编写目的 详细设计（又可称程序设计机）说明书编制的目的是说明一个软件系统各个层次中的每个程序（每个模块或子程序）的实际考虑，为程序员编写程序提供依据。 如果一个软件系统比较简单，层次很少，本文件可以不单独编写，和概要设计机说明书中不重复部分合并编写，文档名称为《软件设计说明书》。 主要内容及写作要求 详细设计说明书主要内容及写作要求如下： 1 引言 目的 。 说明编制本详细设计说明书的目的。 背景 列出本项目的任务提出者、项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展工作直接有关的人员和用户。 参考资料 A. 列出本项目经核准的任务书或合同和上级机关的批文。 B. 列出编写本设计说明书时参考的文件、资料、技术标准以及它们的作者、标题、编号、发布日期和出版单位等。 术语 列出本详细设计说明书中专门术语的定义和英文缩写词的原词组。 ; 2．软件结构 用图表（常用系统流程图的层次结构表示）的形式列出本软件的各模块和程序单元的名称以及它们的相互关系。 3 模块设计说明 模块 n结构（n是模块序号） 将概要设计产生的功能模块进行细化，形成若干个可编程的程序单元（用图表形式给出程序单元的结构）。 算法 给出选用的算法和数学公式。 ： 数据结构 用图表描述数据结构。 程序逻辑 用框图或过程性描述语言的形式表示各程序单元的控制流程（常用程序流程图表示）。存储分配和数组分配 确定每个模块的存储量及数组定义。 单元说明 A. 程序单元标识； }
B. 调用方式； A.参数说明。 4、数据结构设计 数据结构与模块的关系 用图表描述数据结构与模块的关系。 逻辑机结构设计 列出所使用的数据结构中每个数据项、记录和文件的标识、定义、长度、及它们之间的关系。 给出所用数据库的数据模式。 物理结构设计 列出所使用的数据结构中每个数据项的存储要求、访问方法、存取单位和存取物理关系等。
XXX有限公司 XX项目 总体架构设计说明书
总体架构设计说明书文档修订记录 *变化状态：A——增加，M——修改，D——删除
目录 1引言 (5) 1.1目的 (5) 1.2读者对象 (5) 1.3引用文件 (5) 1.4术语表 (5) 2相关框架介绍 (5) 2.1XX框架简介 (5) 2.2XX框架简介 (5) 3系统架构 (6) 4总体设计 (6) 4.1约定 (6) 4.2设计原则 (6) 4.3设计实现 (6) 4.4构件实现 (6) 4.5通用业务处理 (7) 4.6配置文件 (7) 4.7辅助工具介绍 (7)
1引言 1.1目的 [在此对文档的目的进行说明。] 1.2读者对象 [在此对预期读者的角色进行罗列说明。] 1.3引用文件 ?[《XXXXXXXX》文件编号：XXXX_XXX_XXX] ?[《XXXXXXXX》文件编号：XXXX _XXX_XXX] 1.4术语表 2相关框架介绍 [对项目中使用到的框架进行介绍。] 2.1X X框架简介 [在此进行相关框架的产生背景、主要解决的问题、为什么要在项目中引入此框架进行介绍。] 2.2X X框架简介 [在此进行相关框架的产生背景、主要解决的问题、为什么要在项目中引入此框架进行介绍。]
3系统架构 [在此结合架构图概括的描述系统整体结构，特别注意接口的表述。] 4总体设计 4.1约定 4.1.1X X约定 [在此对设计过程中要遵循的约定进行说明。] 4.1.2X X约定 [在此对设计过程中要遵循的约定进行说明。] 4.2设计原则 4.2.1X X设计原则 [在此对设计过程中要遵循的原则进行说明。] 4.2.2X X设计原则 [在此对设计过程中要遵循的原则进行说明。] 4.3设计实现 4.3.1X X设计实现 [在此对设计思路进行详细说明，确保软件设计师和软件开发工程师能够读懂。] 4.3.2X X设计实现 [在此对设计思路进行详细说明，确保软件设计师和软件开发工程师能够读懂。] 4.4构件实现 [我们通常会把在一个或多个项目中用到的界面元素或功能抽象为控件或组件，以达到代码和外观重用的目的。]
XX 详细设计说明书 拟制日期yyyy-mm-dd 评审人日期yyyy-mm-dd 批准日期yyyy-mm-dd <公司或企业图标> <公司或企业中英文名称> 版权所有侵权必究 （仅供内部使用）
修订记录 分发记录
目录 1简介 (6) 1.1目的 (6) 1.2范围 (6) 2详细设计 (6) 2.1模块1详细设计 (6) 2.1.1数据描述 (6) 1.简单数据描述； (6) 2.结构1 (6) 3.结构2 (7) 2.1.2函数描述 (8) 1.函数1 (8) 2.函数2 (9) 2.2模块2详细设计 (10) 2.3错误处理 (10) 2.3.1系统错误 (10) 2.3.2接口错误 (10) 2.3.3协议错误 (10)
表目录No table of contents entries found.图目录 Figure 1Module 1 Structure Chart 模块1结构图 (8)
XX 详细设计说明书 关键词： 摘要： 缩略语清单：<对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。
1 简介 1.1 目的 描述本文的目的，一般详细设计必须能够直接指导编码活动。 1.2 范围 本节应描述文档所包括和不包括的内容。 2 详细设计 对于在概要设计说明书中给出的软件实体，本节集中描述它们的详细描述部分。 2.1 模块1详细设计 描述模块中定义和使用的数据，包括： 简单数据，如模块级的全局变量、常量、宏； 复合数据，如模块内部的结构、联合...； 2.1.1 数据描述 在2.1.1.1中描述本模块中的简单变量、常量、宏； 从2.1.1.2起描述本模块中的复合数据，如结构、联合等； 1. 简单数据描述； 描述在本模块中定义和使用的简单变量、常量、宏； 按照下列格式进行简单数据的描述 功能描述：描述该数据的用途 数据定义：定义该数据 2. 结构1 定义和说明该数据结构(包括联合); 按照下列格式进行数据结构的描述 数据结构描述：描述该数据结构的用途 数据结构定义：用实际的编程语言定义该数据结构 数据项描述：
宿舍管理系统 详细设计说明书 注：对应模块界面图由组员各自完成2013 年12 月 1 日
1.引言 1.1编写目的 编写本详细设计说明书的目的主要是详细说明宿舍管理系统系统的结构和内部设计，在总体设计说明书的基础上进一步细化系统，提供详细的模块和界面设计，为程序开发提供直接的支持。 本说明书主要面向系统分析人员、程序员和以后的系统维护人员。作为程序员开发系统的根本依据和在系统维护阶段，维护人员对系统实施维护的参考资料。 1.2背景 a.系统的名称：宿舍管理系统 b．任务提出者与开发者：李彬，刘泽中 用户：宿舍管理员和学生 1.3定义 2. 系统的结构 系统的功能模块图如下图 2.1：
图2.1 系统功能模块图 多层架构关系图如下图 2.2 查询学生信息 修改学生信息 添加学生信息 删除学生信息 查询宿舍信息 添加宿舍信息 删除宿舍信息 添加管理员信息 查询水电费信息 用户登录 管理员信息管理 学生信息管理 宿舍信息管理 水电费信息管理 宿舍管理系统 修改密码
图2.2 多层架构关系图 根据图2.1功能结构图和图2.2多层架构关系图可得到如下图2.3所示的系统结构设计图：
3．系统的模块设计 3.1数据库连接模块（sqlconnection）设计说明 3.1.1模块名称；数据库连接模块 3.1.2模块描述： 在.NET中如果采用https://www.doczj.com/doc/1c11152643.html,与数据库进行连接，可以采用以下4个接口对象之一： System.data.oledb.oledbconnection System.data.sqlclient.sqlconnection System.data.odbc.odbcconnection System.data.oracleclient.oracleconnection 由于数据库使用的是Microsoft SQL Server,所以使用SQL Server .NET Framework数据提供程序中的SqlConnection对象进行数据连接。 3.1.3 模块功能：与数据库进行连接。 3.1.4 模块算法： public void sqlconnectionopen() { Sqlconnection conn = new sqlconnection(); Conn.connectionstring = “user id = admin;password = ; initial catalog = 宿舍管理系统;datasource = localhost;connect timeout = 20”;
文档作者： 文档呈送： 文档抄送： XX项目 详细设计说明书
变更记录 版本号变化状态修改点说明变更人存放位置审批人审批日期 *变化状态：C――创建，A——增加，M——修改，D——删除 修改点说明：对变化状态进行简单解释，如增加了某项功能，修改了某个模块等信息。不允许出现“根据评审意见修改等字样” 注：当文档未评审通过前版本号标识规则为V0.X ,第一次评审通过后，版本号直接升级为V1.0，之后变更按照V1.X升级。
目录 1前提和约束 (4) 编写目的 (4) 预期读者和阅读建议 (4) 定义、缩写词、略语 (4) 参考资料 (5) 2前提和约束 (6) 前提条件 (6) 限制和约束 (6) 3综合描述 (6) 3.1系统目标 (6) 3.2系统需求 (6) 3.3系统概述 (7) 3.4程序结构说明 (7) 3.5源程序及编译链接组装说明 (7) 4系统详细设计 (7) 4.1XXX子系统名称 (8) 4.1.1XXX包名称 (9) 4.2XXX子系统名称2 (10) 5用户界面详细设计（可裁剪） (10) 5.1界面结构 (11) 5.1.1界面结构或菜单结构 (11) 5.1.2用户界面图（如无此需要，可省略） (11) 5.2界面处理流程及界面约束描述（如无此需要，可省略）错误!未定义 书签。 5.2.1界面或模块名1................................................. 错误!未定义书签。 5.2.2处理流程............................................................ 错误!未定义书签。 5.2.3界面约束与事件约束........................................ 错误!未定义书签。 5.2.4触发方式 (12) 5.2.5界面或模块名2................................................. 错误!未定义书签。6尚未解决的问题 (13) 7资源对象说明 (13)
网站概要设计说明书(模板) 1引言 (2) 1.1编写目的 (2) 1.2背景 (2) 1.3定义 (2) 1.4参考资料 (3) 2总体设计 (3) 2.1需求规定 (3) 2.2运行环境 (4) 2.3基本设计概念和处理流程 (4) 2.4结构 (7) 2.5功能器求和程序的关系 (8) 2.6人工处理过程 (9) 2.7尚未问决的问题 (9) 3接口设计 (9) 3.1学生接口 (9) 3.2外部接口 (9) 3.3内部接口 (10) 4运行设计 (10) 4.1运行模块组合 (10) 4.2运行控制 (10) 4.3运行时间 (10) 5系统数据结构设计 (10) 5.1逻辑结构设计要点 (10) 5.2物理结构设计要点 (12) 5.3数据结构和程序的关系 (12) 6系统出错处理设计 (12) 6.1出错信息 (12) 6.2补救措施 (12) 6.3系统维护设计 (12)
1引言 本说明书为“XXXX网站系统”的概要设计说明书，概要阐述了对学生所提出需求的设计方案，对系统中的各项功能需求、技术需求、实现环境及所使用的实现技术进行了明确定义。同时，对软件应具有的功能和性能及其他有效性需求也进行了定义。此外，本说明书还明确了系统的数据结构和软件结构，还将给出内部软件和外部系统部件之间的接口定义，各个软件模块的功能说明，数据结构的细节以及具体的装配要求。 1.1编写目的 ●编写本说明书的目的是： 1.为编码人员提供依据； 2.为修改、维护提供条件； 3.项目负责人将按计划书的要求布置和控制开发工作全过程； 4.项目质量保证组将按此计划书做阶段性和总结性的质量验证和确认。 ●本说明书的预期读者包括： 1.项目开发人员，特别是编码人员； 2.软件维护人员； 3.技术管理人员； 4.执行软件质量保证计划的专门人员； 5.参和本项目开发进程各阶段验证、确认以及负责为最后项目验收、鉴定提供相应报 告的有关人员； 6.合作各方有关部门的负责人； 7.项目组负责人和全体参加人员。 1.2背景 a.项目名称：XXXX网站系统项目 b.系统名称：XXXX网站系统 c.项目提出者：XXXX d.系统学生：XXXX、XXXX、XXXX 1.3定义 总体设计：对有关系统全局问题的设计，也就是设计系统总的处理方案，又称系统概要设计。它包括：计算机配置设计、系统模块结构设计、数据库和文件设计、代码设计以及系统可靠性和内部控制设计等内容。 运行设计：是针对建筑或环境的特定要求，以活动发生地点的建筑或场地设计及现状
**有限公司 {公司名＋项目名} 详细设计说明书 当前版本： 发布日期： 摘要 简要描述该文档的内容。
修改历史
目录 1概述 (4) 2结构图 (4) 3数据结构 (4) 4功能模块详细描述 (4) 5需求以及设计跟踪表 (4)
1概述 本章描述详细设计将实现的内容，以及受影响的子系统。假如用了软件图形工具，本章必须包含完整的软件图形模块目录的路径名。 2结构图 软件系统功能模块的图形描述，它可以让读者对功能模块有一个全面的了解。同时，它也提供了一个有用的索引及一个有意义的调试和维护指南。 数据必须显示在结构图中，同时，流程线应指明模块访问存储区的目的（读、写或修改）。 必须解释所有的用符号表示的内容（包括模块、参数和数据存储区等）。 3数据结构 ?如果某一数据类型由其它的数据类型组成，要保持信息上的一致性。 ?如果使用一特殊结构，请指明使用原因或优于其它结构的方面。 ?在选择一个有效的结构时，要考虑以下几个方面： -- 在目标上执行的操作类型 -- 访问目标的类型和频度 -- 结构的有效性 4功能模块详细描述 首先请简要介绍模块的目的。可以用以下格式描述功能模块的详细设计： ?模块名称 ?主要功能描述 ?模块的输入参数的名称、数据类型、顺序位置、格式等 ?模块的输出参数的名称、数据类型、顺序位置、格式，以及错误标记等 ?过程和功能调用 ?数据引用（全局，本地，结构） ?模块的处理流程（采用流程图、判定表辅以必要的说明来表示逻辑流程） ?模块的界面设计（可以采用图片和表格的形式，具体内容包括：界面格式；界面要素的位置、类型和特殊约定；操作及步骤等必要的说明） ?接口（用图的形式说明本程序所隶属的上一层模块及隶属本模块的下一层模块，说明参数赋值和调用方式，说明与本程序直接关联的数据结构） ?限制条件（说明本模块运行所受到的限制条件） ?伪代码 5需求以及设计跟踪表
概要设计说明书 文档编号：FHI_CMMI_TS_TEM_SUMD 文档信息：概要设计说明书 文档名称：概要设计说明书 文档类别：CMMI模板 密级：内部秘密 版本信息：1.1 建立日期：2016-1-5 创建人：EPG 批准人：李庆林 批准日期：2016.2.25 存放位置：集成公司组织资产库/组织标准过程 编辑软件：Microsoft Office 2003 中文版
*变化状态：C――创建，A——增加，M——修改，D——删除
目录 1导言 (4) 1.1目的 (4) 1.2范围 (4) 1.3命名规则 (4) 1.4术语定义 (4) 1.5相关文档 (5) 1.6参考资料 (5) 2总体结构设计 (5) 2.1总体结构图设计 (5) 2.2运行环境设计 (6) 2.3子系统清单 (6) 2.4功能模块清单 (7) 3模块功能分配 (7) 3.1一级模块功能名称 (7) 4外部接口设计 (8) 4.1外部接口模块清单 (8) 4.2外部接口1设计 (8) 4.3外部接口2设计 (8) 5出错处理设计 (9) 5.1出错输出信息 (9) 5.2出错处理对策 (9) 6其它设计 (9)
1导言 本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。 1.1目的 本文档的目的旨在推动软件工程的规范化，使设计人员遵循统一的概要设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。 1.2范围 本文档用于软件设计阶段的概要设计，它的上游（依据的基线）是需求分析规格书，它的下游是系统详细设计说明书，并为详细设计说明书提供测试的依据。 软件概要设计的范围是：软件系统总体结构、外部接口、主要部件功能分配、全局数据结构以及部件之间的接口等方面的内容。 1.3命名规则 1.变量对象命名规则 申明全局变量、局部变量对象的命名规则。 2.数据库对象命名规则 申明数据库表名、字段名、索引名、视图名对象的命名规则。 1.4术语定义
东软机密 文件编号：D05-PDT073 详细设计说明书模板 版本：0.0.0-1.2.0 2009-6-30 东软集团股份有限公司软件开发事业部 (版权所有，翻版必究)
文件修改控制 修改编号版本修改条款及内容修改日期 1 0.0.0-1.1.0修改LOGO 2005-7-29 2 0.0.0-1.1.1 1、修改公司标识为“东软集团股份有限公司”。 2、修改文件密级标识为“东软机密”。 2008-8-25 3、将“单体测试”改为“单元测试” 3 0.0.0-1.2.0 根据公司要求，转换为OpenOffice格式2009-06-17
东软机密 文件编号：项目编号DDR顺序号第版分册名称：第册/共册 项目名称（项目编号） 详细设计说明书 (软件开发事业部) 东软集团股份有限公司 总页数正文附录生效日期 编制批准
修改记录 版本号变更控制报告 编号 更改条款及内容更改人审批人更改日期
目录 1引言 (1) 1.1 目的 (1) 1.2 背景 (1) 1.3 词汇表 (1) 1.4 参考资料 (1) 2系统结构 (1) 2.1 需求概述 (1) 2.2 总体设计 (2) 3.系统详细设计说明 (2) 3.1 包及类结构设计 (2) 3.2 模块设计 (2) 3.3 Message文件管理Module (2) 3.4 LOG管理Module (2) 3.5 配置文件管理Module (2) 3.6 异常模块说明 (3) 4.其他设计要求 (3) 4.1 单元测试 (3) 4.2 注释及代码风格 (3) 4.3 尚未解决问题 (3) 5附件说明 (3)
<集团公司管理系统> 详细设计说明书 版本 <1.2>
修订历史记录
1．引言 (3) 1.1编写目的 (3) 1.2项目背景 (4) 1.3定义 (4) 1.4参考资料 (4) 2．总体设计 (4) 2.1需求概述 (4) 2.2软件结构 (5) 3．程序描述 (6) 3.1功能 (6) 3.2性能 (6) 3.3输入项目 (6) 3.4输出项目 (6) 3.5算法 (6) 3.6程序逻辑 (6) 3.7接口 (7) 3.8存储分配 (7) 3.9限制条件 (7) 3.10测试要点 (7) 1．引言 1.1编写目的 在前一阶段（概要设计说明书）中，已解决了实现该系统需求的程序模块设计问题。包括如何把该系统划分成若干个模块、决定各个模块之间的接口、模块之间传递的信息，以及数据结构、模块结构的设计等。在以下的详细设计报告中将对在本阶段中对系统所做的所有详细设计进行说明。 在本阶段中，确定应该如何具体地实现所要求的系统，从而在编码阶段可以把这个描述直接翻译成用具体的程序语言书写的程序。主要的工作有：根据在《需求分析说明书》中所描述的数据、功能、运行、性能需求，并依照《概要设计说明书》所确定的处理流程、总体结构和模块外部设计，设计软件系统的结构设计、逐个模块的程序描述（包括各模块的功能、性能、输入、输出、算法、程序逻辑、接口等等）。 在以下的各个阶段中，《用户操作手册》将与本阶段的工作紧密结合，努力作到让用户易懂易学。 系统的测试和维护也将参考本说明书，检验本系统的各项性能指标，及时发现纰漏及时修补，一定要把功能强大、稳定可靠、便于维护的集团公司管理系统交到用户手中。