XXX(XXX)详细设计说明书(模板)

XXX（XXX）

详细设计说明书

编写XXX 2011 年XX 月XX 日审核年月日批准年月日

北京XXX有限公司

版本控制

第1页共6页

目录

1引言 (3)

1.1编写目的 (3)

1.2项目背景 (3)

1.3定义 (3)

1.4参考资料 (3)

2总体设计 (4)

2.1需求概述 (4)

2.2程序系统结构 (4)

3程序/模块描述 (4)

3.1程序/模块1（标识符）描述 (4)

3.1.1功能 (4)

3.1.2性能 (5)

3.1.3输入项 (5)

3.1.4输出项 (5)

3.1.5算法 (5)

3.1.6程序/流程逻辑 (5)

3.1.7接口 (5)

3.1.8存储分配 (6)

3.1.9注释设计 (6)

3.1.10限制条件 (6)

3.1.11程序/模块测试要点及计划 (6)

3.1.12尚未解决的问题 (6)

3.2程序/模块2（标识符）描述 (6)

3.3以此类推 (6)

第2页共6页

1 引言

1.1 编写目的

阐述编写详细设计说明书的目的，指出读者对象。

1.2 项目背景

应包括：

A．待开发软件系统的名称（软件缩写代号）；

B．项目的来源和主管部门。

1.3 定义

列出文档中用到的专门术语的定义和缩写词的原文。

1.4 参考资料

列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：

A．项目经核准的计划任务书、合同或上级机关的批文；

B．项目立项报告；

C．项目开发方案；

D．需求规格说明书；

E．概要设计说明书；

F．项目计划；

G．测试计划（初稿）；

H．测试方案（初稿）；

I．测试用例（初稿）；

J．用户操作手册（初稿）；

K．文档中所引用的资料，标准和规范。

第3页共6页

2 总体设计

2.1 需求概述

2.2 程序系统结构

用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符及他们之间的层次结构关系。

给出软件系统的结构图。

说明：所有结构图、流程图和图表均采用VIVSO制作。

3 程序/模块描述

从本章节开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于每一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。

说明：逐个程序/模块给出如下小章节的说明。

3.1 程序/模块1（标识符）描述

给出对该程序/模块的简要描述，主要说明安排设计本程序的目的意义。且，还要说明本程序的特点（如：是常驻内存还是非常驻？是否是子程序？是可重用的还是不可重用的？有无覆盖要求？是顺序处理还是并发处理等）。

3.1.1 功能

说明该程序应具有的功能，可采用IPO图（即输入——处理——输出图）的形式。

第4页共6页

3.1.2 性能

说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。

3.1.3 输入项

给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式等内容，数量和频度、输入媒体、输入数据的来源和安全保密条件等等。

3.1.4 输出项

给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、数量和频度、输出媒体、对输出图形及符号的说明和安全保密条件等等。

3.1.5 算法

详细说明该程序/模块所选用的算法，具体的计算公式和计算步骤。

3.1.6 程序/流程逻辑

详细描述模块算法、程序/流程逻辑。可采用：

A．标准流程图；

B．PDL语言；

C．N-S图；

D．PAD；

E．判定表等描述算法的图表。

3.1.7 接口

用图的形式说明本程序/模块所隶属的上一层程序/模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序/模块相直接关联的数据结构（数据库、数据文卷）。

第5页共6页

3.1.8 存储分配

根据需要，说明本程序/模块的存储分配。

3.1.9 注释设计

说明准备在本程序/模块中安排的注释，如：

A．加在模块首部的注释；

B．加在各分支节点处的注释；

C．对各变量的功能、范围、缺省条件等所加注的注释；

D．对使用的逻辑所加的注释等等。

3.1.10 限制条件

说明本程序/模块运行中所收到的限制条件。

3.1.11 程序/模块测试要点及计划

给出程序/模块进行单体测试的计划和要点，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定、要求和方法。

3.1.12 尚未解决的问题

说明在本程序/模块的设计中尚未解决而设计者认为在软件完成之前应解决的问题。

3.2 程序/模块2（标识符）描述

仿照3.1章节中的内容和结构进行该小节内容的编写。

3.3 以此类推……

第6页共6页