详细设计说明书编写规范.doc

详细设计说明书编写规范 案卷号 日期 ＜项目名称＞ 详细设计说明书 作 者 完成日期 签 收 人 签收日期 修改情况记录 版本号 修改批准人 修改人 安装日期 签收人 目录 1 引言1 1.1 编写目的1 1.2 背景1 1.3 定义1 1.4 参考资料1 2 程序系统的结构1 3 程序1（标识符）设计说明2 3.1 程序描述2 3.2 功能2 3.3 性能2 3.4 输入项2 3.5 输出项2 3.6 算法3 3.7 流程逻辑3 3.8 接口3 3.9 存储分配3 3.10 注释设计3 3.11 限制条件3 3.12 测试计划3 3.13 尚未解决的问题4 4 程序2（标识符）设计说明4 详细设计说明书编写规范 1 引言 1.1 编写目的 说明编写这份详细设计说明书的目的，指出预期的读者范围。 1.2 背景 说明 a． 待开发的软件系统的名称； b． 列出本项目的任务提出者、开发者、用户以及将运行该项软件的单位。 1.3 定义 列出本文件中用到的专门术语的定义和缩写词的原词组。 1.4 参考资料 列出要用到的参考资料，如 a． 本项目的经核准的计划任务书或合同、上级机关的批文； b． 属于本项目的其他已发表的文件； c． 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 程序系统的结构 用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。 3 程序1（标识符）设计说明 从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。 3.1 程序描述 给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如是常驻内存还是非常驻是否子程序是可重入的还是不可重入的有无覆盖要求是顺序处理还是并发处理．．．．．等）。 3.2 功能 说明该程序应具有的功能，可采用IPO图（即输入－处理－输出图）的形式。 3.3 性能 说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。 3.4 输入项 给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式、数量和频度、输入媒体、输入数据的来源和安全保密条件等等。 3.5 输出项 给出对每一个输出项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输出的形式、数量和频度、输出媒体、对输出图形及符号的说明、安全保密条件等等。 3.6 算法 详细说明本程序所选用的算法，具体的计算公式和计算步骤。 3.7 流程逻辑 用图表（例如流程流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。 3.8 接口 用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。 3.9 存储分配 根据需要，说明本程序的存储分配。 3.10 注释设计 说明准备在本程序中安排的注释，如 a． 加在模块首部的注释； b． 加在各分枝点处的注释； c． 对各变量的功能、范围、缺省条件等所加的注释； d． 对使用的逻辑所加的注释等等。 3.11 限制条件 说明本程序运行中所受到的限制条件。 3.12 测试计划 说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。 3.13 尚未解决的问题 说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。 4 程序2（标识符）设计说明 用类似第3章的方式，说明第2个程序乃至第N个程序的设计考虑。 ．．．．．． 第 4 页