软件质量QR-20-03详细设计说明书

1、.质量管理运作体系文件三级文件 记录编号：详细设计说明书的目录详细设计说明书又可称程序设计说明书。编制目的是说明一个软件系统各个层次中的每一个程序（每个模块或子程序）的设计考虑，如果一个软件系统比较简单，层次很少，本文件可以不单独编写，有关内容合并如概要设计说明书。对详细设计说明书的内容要求如下：1 引言1.1 编写目的1.2 背景1.3 定义1.4 参考资料2 程序系统的组织结构3 程序1（标识符）设计说明3.1 程序描述3.2 功能3.3 性能3.4 输入项3.5 输出项3.6 算法3.7 流程逻辑3.8 接口3.9 存储分配3.10 注释设计3.11 限制条件3.12 测试计划3.13

2、尚未解决的问题4 程序2（标识符）设计说明详细设计说明书的编写提示1 引言1.1 编写目的 说明编写这份详细设计说明书的目的，指出预期的读者。1.2 背景 说明：¨ 待开发软件系统的名称；¨ 本项目的任务提出者、开发者、用户和运行程序系统的计算中心。1.3 定义 列出本文件中用到专门术语的定义和外文首字母组词的原词组。1.4 参考资料 列出有关的参考资料，如：¨ 本项目的经核准的计划任务书或合同，上级机关的批文；¨ 属于本项目的其他已发表的文件；¨ 本文件中各处引用到的文件资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期

3、和出版单位。说明能够取得这些文件的来源。2 程序系统的结构用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的 名称、标识符和它们之间的层次结构关系。3 程序1（标识符）设计说明 从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。3.1 程序描述 给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如是常驻内存还是非常驻？是否子程序？是可重入的还是不可重入的？

4、有无覆盖要求？是顺序处理还是并发处理等）。3.2 功能 说明该程序应具有的功能，可采用IPO图（即输入处理输出图） 的形式。3.3 性能 说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要 求。3.4 输入项 给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式、数量和频度、输入媒体、输入数据的来源和安全保密条件等等。3.5 输出项 给出对每一个输出项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输出的形式数量和频度、输出媒体、对输出图形及符号的说明、安全保密条件等等。3.6 算法 详细说明本程序所选用的算法，具体的计算公式和计算步骤

5、。3.7 流程逻辑 用图表（例如流程图、判定表）等辅以必要的说明来表示本程序的逻辑流程。3.8 接口 用图的形式说明本程序所隶属的上层模块及隶属于本程序的下一层模块、子程序、说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。3.9 存储分配 根据需要，说明本程序的存储分配。3.10 注释设计 说明准备在本程序中安排的注释，如：¨ 加在模块首部的注释；¨ 加在各分支点处的注释；¨ 加各变量的功能、范围缺省条件等所加的注释；¨ 对使用的逻辑所加的注释等等。3.11 限制条件说明本程序运行中所受到的限制条件。3.12 测试计划说明对

6、本程序进行单体测试的计划，包括对测试的技术要求、输入 数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块的规定。3.13 尚未解决的问题 说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。4 程序2（标识符）设计说明用类似1.3的方式，说明第2个程序乃至第N个程序的设计考虑。附录二 程序流程图画法提示 程序流程图也称为程序框图，是软件开发者最熟悉的一种算法表达工具。它独立于任何一种程序设计语言，比较直观、清晰，易于学习掌握。因此，至今仍是软件开发者最普遍采用的一种工具。人们在需要了解别人开发软件的具体实现方法时，常常需要借助流程图，来理解其思路及处理方法。但是，流程

7、图也存在一些严重的缺点。例如流程图所使用的符号不够规范，常常使用一些习惯性用法。特别是表示程序控制流程的箭头，使用的灵活性极大，程序员可以不受任何约束，随意转移控制。这些问题常常会使程序质量受到很大的影响。这些现象显然是与软件工程化的要求相背离的。为了消除这些缺点，应对流程图所用的符号做出严格的定义，不允许人们随心所欲地画出各种不规范的流程图。首先，为使用流程图描述结构化程序，必须限制流程图只能使用图1所给出的五种基本控制结构。这五种基本的控制结构是：(1) 顺序型：几个连续的加工步骤依次排列构成；(2) 选择型：由某个逻辑判断式的取值决定选择两个加工中的一个；(3) 先判定(while)型循

8、环：在循环控制条件成立时，重复执行特定的加工；(4) 后判定(until)型循环:重复执行某些特定的加工，直至控制条件成立；1)顺序型 2)选择型 5)多情况选择型 (CASE型)3)先判定型循环 4)后判定型循环 (DO-WHILE) (DO-UNTIL)图1 流程图的基本控制结构(5) 多情况(case)型选择：列举多种加工情况，根据控制变量的取值，选择执行其一。任何复杂的程序流程图都应由这五种基本控制结构组合或嵌套而成。作为上述五种控制结构相互组合和嵌套的实例，图2给出一个程序的流程图。图中增加了一些虚线构成的框，目的是便于理解控制结构的嵌套关系。显然，这个流程图所描述的程序是结构化的。

9、图2 嵌套结构的流程图实例其次，需要对流程图所用的符号做出确切的规定。除去使用规定的符号之外，流程图中不允许出现任何其他符号。图4.38给出国际标准化组织提出，并已为中国国家技术监督局批准的一些程序流程图标准符号，其中多数所规定的使用方法与普通的使用习惯用法一致。起止端点 数据输入输出 处理 准备或预处理 预定义处理或既定处理 条件判断 循环上界 循环下界 文件或文档 外接 内接 流线 虚线 省略线 并行方式 注解或注释 图3 标准程序流程图的规定符号需要说明的几点是：(1) 循环的界限设有一对特殊的符号。循环开始符是削去上面两个直角的矩形，循环结束符是削去上面两个直角的矩形，其中应当注明循环

10、名和进入循环的条件(对于while型循环)或循环终止的条件(对于until型循环)。通常这两个符号应在同一条纵线上，上下对应，循环体夹在其间。参看图3表示的两种类型循环的符号用法。(2) 流线表示控制流的流向。在自上而下，或自左而右的自然流向情形，流线可不加箭头。否则必须在流线上加上箭头。(3) 注解符可用来标识注解内容，其虚线连在相关的符号上，或连接一个虚线框(框住一组符号)。参看图4的例子。图4 注解符的使用(4) 判断有一个入口，但有多个可选出口。在判断条件取值后有一个且仅有一个出口被激活。取值结果可在流线附近注明。显然，两出口的判断就是前面提到的选择型结构，多出口的判断即为CASE型结

11、构。图4.41给出多出口判断的表示。图4.41(a)、图4.41(b)和图4.41(c)分别表示具有3、5和4个出口的判断。 (a) b) (c) 图5 多出口判断虚线表示两个或多个符号间的选择关系(例如，虚线连接了两个符号，则表示这两个的符号中只选用其中的一个)。另外，虚线也可配合注解使用。参看图2。(5) 外接符及内接符表示流线在另外一个地方接续，或者表示转向外部或从外部转入。附录三 模块开发卷宗的编写提示1. 引言软件系统名称和标识符模块名称和标识符（如果本卷宗包含多于一个的模块，则用这组模块的功能 标识代替模块名） 程序编制员签名 卷宗的修改文本序号 修改完成日期 卷宗序号（说明本卷宗

12、在整个卷宗中的序号） 编排日期（说明整个卷宗最近的一次编排日期）2. 模块开发情况表3. 功能说明扼要说明本模块（或本组模块）的功能，主要是输入、要求的处理、输出。可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明的章、条、款。4. 设计说明 说明本模块（或本组模块）的设计考虑，包括：1) 系统设计说明书中有关对本模块（或本组模块）设计考虑的叙述，包括本模块在软件系统中所处的层次，它同其他模块的接口；2) 在程序设计说明书中有关对本模块（或本组模块）的设计考虑，包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等；3) 在编制目前已通过全部测试的源代码时实际使用的设计考虑。5.