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

案卷号 日期 ＜项目名称＞ 详细设计说明书 作 者： 完成日期： 签 收 人： 签收日期： 修改情况记录： 版本号 修改批准人 修改人 安装日期 签收人 1、首页主要检查排版是否美观、整齐；是否有编写日期；文档名称和文件命名是否一致；是否显示页码；项目名称是否正确。 目录 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 2、主要是看页码显示是否正确、对齐；目录编号是否正确或者有缺漏；如果没有目录，作为完成的文档，必须补上目录；是否也显示了页码，一般上不需要；目录的结构是否合理。目录的主要部分：引言、程序系统结构、程序设计这几部分是否齐全。 1 引言 1.1 编写目的 说明编写这份详细设计说明书的目的，指出预期的读者范围。 3、描述详细设计的目的，是为下一步的编码做好准备，预期读者主要是开发人员。审核重点是看目的是否明确。 1.2 背景 说明： 待开发的软件系统的名称； 列出本项目的任务提出者、开发者、用户以及将运行该项软件的单位。 4、项目开发背景的描述，并对用户进行分析。这里审核的重点是看背景描述是否清楚，是否有针对性。该系统主要有哪些用户，是否正确。 1.3 定义 列出本文件中用到的专门术语的定义和缩写词的原词组。 5、对特别的词做相应的说明，特别是有区别与一般语义的词，或者是项目中重点的词。这里重点审查词的说明性定义是否正确，是否符合项目的建设定义。 1.4 参考资料 列出要用到的参考资料，如： 本项目的经核准的计划任务书或合同、上级机关的批文； 属于本项目的其他已发表的文件； 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 6、上级下发的文件，相关的规范标准，招投标文件，需求规格说明书，概要设计，业务制度规范等都可以在这里列出。重点审核文件名是否正确，文件是否存在。概要设计是详细设计的基础，不能少。 2 程序系统的结构 用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。 7、系统结构最好是先由总体结构图，再分别列出功能模块图的形式表达，并且加以文字说明它们之间的联系。这里重点审核结构图的内容是否正确，功能模块是否完整，是否有一定的文字说明。 3 程序1（标识符）设计说明 从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。 8、这部分的内容是详细设计必不可少的内容，对每一个模块进行详细的说明，也可以通过表格的方式，分别进行描述。 3.1 程序描述 给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如是常驻内存还是非常驻？是否子程序？是可重入的还是不可重入的？有无覆盖要求？是顺序处理还是并发处理？．．．．．等）。 9、对程序功能的简单描述，重点审核它的合理性以及它的正确性。 3.2 功能 说明该程序应具有的功能，可采用IPO图（即输入－处理－输出图）的形式。 10、重点内容，不能少。采用IPO图的方式，重点看它的输入输出是否正确。 3.3 性能 说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。 11、这部分是对程序的性能的分析，也是不能少的内容，重点审核它的性能度和需求是否对应，是否合理。 3.4 输入项 给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式、数量和频度、输入媒体、输入数据的来源和安全保密条件等等。 12、这部分