详细设计文档规范

详细设计说明书

引言【概要设计文档相似】

编写目的

背景

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

参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,这里可以写上需求文档等】

程序系统结构

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

程序一(标识符)设计说明【这里可以适时增加或者减少某些模块】

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

程序描述

【给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且,还要说明本程序的特点(如 是常驻内存还是非常驻?是否子程序?是可重人的还是不可重人的?有无覆盖要求?是顺序处理还是并发处理等)。】

功能

【说明该程序应具有的功能,可采用IPO图(即输入一处理一输出图)的形式。】

性能

【说明对该程序的全部性能要求。】

输入项

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

输出项

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

算法

【详细说明本程序所选用的算法,具体的计算公式和计算步骤。】

逻辑流程

【用图表(例如流程图、判定表等)辅以必要的说明来表示本程序的逻辑流程。】

接口

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

存储分配

【根据需要,说明本程序的存储分配。】

注释设计

【说明准备在本程序中安排的注释,如:

a. 加在模块首部的注释;

b. 加在各分枝点处的注释;

c. 对各变量的功能、范围、缺省条件等所加的注释;

d. 对使用的逻辑所加的注释等等。】

限制条件

【说明本程序运行中所受到的限制条件】

测试计划

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

尚未解决的问题

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

本站公众号
   欢迎关注本站公众号,获取更多程序园信息
开发小院