详细设计说明书编写规范

详细设计说明书编写规范编号：MPDK/ZY-14-2007修改号：0发放号：发布时间：2007-06-28实施时间：2007-06-28编制：批准：详细设计说明书编写规范1.目的技术报告编写规范主要描述在软件产品或软件项目开发完成时所需编写的详细设计应该包含的内容，使得本公司编写的报告便于软件产品或软件项目日后的维护、交接和代码重用。2.适用范围适用于本公司软件产品或软件项目的详细设计的编写。3.编写规范3.1排版规范1）整个规范由2节构成，模板单独一节。2）标题编号采用每节独立编号。3.2模板使用1）拷贝规范。2）删除第一节（技术报告封面前的所有页）。3）在修改完内容后，更新目录域和相关的页数域。(项目编号)详细设计说明书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．加在各分枝点处的注释；对各变量的功能、范围、缺省条件等所加的注释；d．对使用的逻辑所加的注释等等。4程序2（标识符）设计说明用类似3的方式，说明第2个程序乃至第N个程序的设计考虑。