软件开发详细设计模板(全面详细)

软件详细设计
发放编号：
软件详细设计
模板
2012-09-发布 2011-10-实施
修订记录
注：审签人可以是审核人、批准人或签发人。

文档编号：密级：版本号：期限：
软件详细设计
编写：YYYYMMDD
校对：YYYYMMDD
审核：YYYYMMDD
批准：YYYYMMDD
签发：YYYYMMDD
XXXXXXXXXXXXXXX公司
YYYY年MM月
修订记录
注：审签人可以是审核人、批准人或签发人。

目录
1概述 (1)
1.1背景 (1)
1.2参考资料 (1)
2总体设计 (1)
2.1模块描述 (1)
2.1.1在系统中的位置 (1)
2.1.2功能 (1)
2.1.3性能 (1)
2.2开发及运行环境 (1)
2.2.1硬件环境 (1)
2.2.2软件环境 (1)
2.3CBB及标准化设计 (1)
2.3.1引用模块说明（可选，全新领域开发） (2)
2.3.2本模块可能输出的共享模块说明 (2)
2.4可靠性设计 (2)
2.5可测试性设计 (2)
2.6安全性设计（可选） (2)
2.7接口设计 (3)
2.7.1用户接口 (3)
2.7.2硬件接口 (3)
2.7.3软件接口 (3)
2.8数据描述 (3)
2.8.1数据结构说明 (3)
2.8.2全局变量说明（可选） (3)
2.8.3数据库说明（可选） (3)
2.9函数定义/类定义 (3)
2.9.1引用函数定义 (3)
2.9.2内部函数定义 (4)
2.9.3类1 (4)
2.9.4类n (4)
2.10关键技术说明 (4)
3模块设计 (5)
3.1模块设计准则 (5)
3.2实现原理 (5)
3.3模块设计的备选方案（可选） (5)
3.4功能划分 (5)
3.5功能实现 (5)
3.5.1××××功能的实现 (5)
3.5.2××××功能的实现 (5)
软件详细设计
1 概述
1.1 背景
【引用概要设计与本模块相关内容】
1.2 参考资料
【引用与本模块设计相关的参考资料】
2 总体设计
2.1 模块描述
2.1.1在系统中的位置
【以逻辑结构图描述本模块在系统中的位置，说明本模块和系统中其它模块的关系。

】
2.1.2功能
【说明本模块的主要功能，及包含那些子功能等。

】
2.1.3性能
【说明本模块的性能指标如CPU利用率，代码大小、执行速度、内存利用率、通信速率、算法复杂度等。

】
2.2 开发及运行环境
2.2.1硬件环境
【说明开发本软件系统所需的硬件环境，如计算机、存储设备、网络设备等。

说明本软件系统对实际运行硬件环境的最低要求及适用范围。

】
2.2.2软件环境
【说明开发本软件系统所需的软件环境，如操作系统、数据库系统、程序设计语言、CASE （Computer-Aided Software Engineering）工具、开发工具等。

必要时，说明本软件系统运行在怎样的软件支撑环境下。

必要时，说明本软件系统可支持的其他软件开发。

】
2.3 CBB及标准化设计
【说明本模块在产品模块库、事业部模块库以及当前项目中引用的标准模块的内容和应用方式、描述本模块中可能抽象的公用模块及其应用范围。

若本模块调用了购买的商用模块，也应予以详细说明。

】
2.3.1引用模块说明（可选，全新领域开发）
【从各级模块库中查询关键字，并以表格形式列出查询结果。

从查询结果中分析出本模块可能引用到的模块，并以表格的形式。

】
表2-1 本模块拟引用的模块
2.3.2本模块可能输出的共享模块说明
【以表格的形式说明本模块可能输出的共享模块.】
表2-2 本模块可能输出的共享模块说明
2.4 可靠性设计
【说明本模块对于可能发生的异常情况需要采用的软件可靠性设计技术。

比如：
1.硬件发生局部故障时，软件采用何种可靠性设计技术，保证整个系统的正常工作；
2.用户误操作或非法操作时，软件采用何种可靠性设计技术，防止系统瘫痪；
3.对接口函数是否进行参数有效必检查，是否有指针越界检查
4.对于关键程序和数据，采用何种软件可靠性设计技术，提高其可靠程度。

】
2.5 可测试性设计
【说明对本模块的测试方法、设置测试点的技术、测试的范围和内容。

如对功能和性能、容错性等进行测试等】
2.6 安全性设计（可选）
【分析本模块可能发生的危险的严重性等级和可能性等级，进行系统危险分析和防范。

如：
1.为防止盗版和防止非法用户进入系统所采用的加密技术；
2.对重要数据和信息所采用的加密技术；
3.对可能造成意外人身伤害、重大经济损失的设备及情况应采用的安全性设计。

4.系统数据的备份和恢复，以及系统数据一致性的校验等设计。

】
2.7 接口设计
2.7.1用户接口
【说明由用户提供的命令和语法结构，以及软件的回答信息。

说明误操作的处理措施，以避免无意激活。

】
2.7.2硬件接口
【详细说明本软件模块与硬件之间接口，描述每个接口的具体要求和接口的相关内容。

说明检测外部输入输出设备失效的恢复措施。

说明数据传输信息的格式和内容。

】
2.7.3软件接口
2.7.
3.1 规范接口（可选）
【列出本软件模块提供的符合接口规范的软件接口。

】
2.7.
3.2 非规范接口（可选）
【详细说明本软件模块提供的规范接口以外的软件接口。

】
2.8 数据描述
2.8.1数据结构说明
【说明本模块内部用到的主要数据结构。

定义模块所使用的各种数据，规定静态数据、动态输入输出数据及内部生成数据的逻辑结构，列出这些数据的清单，并说明对数据的约束。

对重要的数据，要在使用前进行检验的方式。

任何数据都必须规定其合理的范围。

说明在任何时候都要对重要的数据进行合理性检查，以及采取的故障隔离处理措施。

】
2.8.2全局变量说明（可选）
【指出本模块关键全局变量及其使用说明。

】
2.8.3数据库说明（可选）
【对所使用的数据库及使用数据库的方式作详细说明。

】
2.9 函数定义/类定义
2.9.1引用函数定义
【列出XXXX功能所引用的接口函数，如OSS（操作支持系统）和DBS（数据库系统）定义的接口函数。

】
2.9.1.1 引用函数1
【语法：<说明函数原型>
输入参数：<对输入参数进行说明>
输出参数：<对输出参数进行说明>
返回值：<对返回值进行说明>
描述：对该函数作简要描述】
2.9.2内部函数定义
【详细说明模块内部处理所使用的函数，如编解码函数、特殊计算函数等关键函数、含关键算法的函数。

】
2.9.2.1 内部函数1
【语法：<说明函数原型>
输入参数：<对输入参数进行说明>
输出参数：<对输出参数进行说明>
返回值：<对返回值进行说明>
描述：对该函数作简要描述】
2.9.2.2 内部函数n
【语法：<说明函数原型>
输入参数：<对输入参数进行说明>
输出参数：<对输出参数进行说明>
返回值：<对返回值进行说明>
描述：对该函数作简要描述】
2.9.3类1
【适用于面向对象程序设计】
2.9.4类n
【适用于面向对象程序设计】
2.10 关键技术说明
【说明本模块在设计和开发过程中，需掌握哪些关键技术（包括关键组件的获得等），有哪些技术难点和不确定的技术问题，说明对这些关键技术的解决方案。

】
3 模块设计
3.1 模块设计准则
【列出模块设计的准则，如运行速度、算法复杂度、代码空间等的要求。

】
3.2 实现原理
【以逻辑结构图描述模块的内部逻辑，主要使用文字描述模块的实现原理。

要根据7.1节模块设计准则，与其它方案进行比较，指出此实现原理的优缺点。

】
3.3 模块设计的备选方案（可选）
【以逻辑结构图描述模块备选方案的内部逻辑，主要使用文字描述模块的实现原理。

比较出备选方案与7.2节中实现原理的异同点，指出在何种情况下采用此备选方案。

】
3.4 功能划分
【为了使整个模块各程序结构清晰易读，在设计时，把该模块划分为如下几个子模块。

】
3.5 功能实现
3.5.1××××功能的实现
【主要用文字对子信号流(或事件流)进行描述。

画出主要流程的MSC图（消息顺序图）或程序流程图。

对异常处理或错误处理进行说明。

】
3.5.2××××功能的实现
【主要用文字对子信号流(或事件流)进行描述
画出主要流程的MSC图或程序流程图。

对异常处理或错误处理进行说明】。