详细设计的文档

详细设计结束后，应完成以下文档：

■详细设计说明书

■模块开发卷宗

下面详细说明两文件的内容。

详细设计说明书

详细设计说明书又叫程序设计说明书。说明书的目的是用来说明一个软件系统的各个层次中的每个程序（每个模块或子程序）的设计考虑。如果系统比较简单，层次很少，可以不单独编写，把有关的内容并入概要设计说明书中。详细设计说明书的内容包括引言、程序系统的组织结构以及各个程序的设计说明几个部分。

①引言

引言论述详细设计说明书的编写目的、背景，需特别说明的定义和有关的参考资料等内容。

②程序系统的组织结构

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

③程序（标识符）设计说明

程序（标识符）设计说明对本程序系统内的各个程序（包括每个模块和子程序）的有关设计内容作逐一说明，对每个程序的说明包括以下 13 项内

容。

程序描述：简要说明程序的主要内容，如：本程序的目的、意义，本程序的特点（是否常驻内存，是否有子程序，是否可重入，有无覆盖要求，是顺序还是并发处理等。）

功能：采用某种设计方法对各个子程序模块进行过程描述。

性能：是对程序系统运行效率的说明，包括空间要求、算法精度、灵活性、时间特性等。

输入项：列举每个输入项的名称、标识、数据的类型和格式、数据值的有效范围、输入的方式、数量和频度、输入媒体、输入数据来源和安全保密等。

输出项：内容同输入项类似，但加上输出的图形和符号说明。算法：详细描述具体的实现算法，包括计算公式和计算步骤等。

接口：说明本程序和上、下层模块的关系，参数赋值和调用方式，和它直接相关的数据结构（数据库、数据文卷等）。

流程逻辑：用图表的形式说明程序的处理流程。存贮分配：说明程序对存贮器的使用和分配情况。

注释设计：说明需在程序中安排的注释。如：加在模块首部的注释，加在各分支点处注释，对各变量的功能、范围、缺省条件注释等，对使用逻辑等所加的注释。

限制条件：说明本程序系统在运行时所受到的限制。

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

模块开发卷宗

模块开发卷宗是在模块开发过程中逐步编写出来的，每完成一个模块或一组密切相关的模块的复审时编写一份。应把所有的模块开发卷宗汇集在一起，目的是记录和汇总低层次开发的进度和结果，以便于对整个模块开发工作的管理和复审，并为将来的维护提供非常有用的技术信息。模块开发卷宗是组织和保存开发过程中不断产生的文档的有效方法。

模块开发卷宗包括以下内容：

①标题封面；

②模块开发情况表：用二维表格说明开发进度；

③功能说明；

④设计说明；

⑤源代码清单；

⑥测试说明；

⑦复审的结论。