设计说明怎么写-详细设计说明书模板
以下为对所提供内容的改进和扩充后的版本:
详细设计说明书
编写目的及预期读者范围
说明
- 待开发的软件系统名称及项目背景简介。
- 明确指出本详设的读者群,包括项目任务提出者、开发者、用户及将运行该项软件的单位。
专门术语与缩写词定义
- 列出本文件中用到的专门术语和缩写词的原词组,并给出其定义。
参考资料
- 列出本项目的经核准的计划任务书或合同、上级的批文等官方文件。
- 列出已发表的与本项目相关的文件资料。
- 列出软件开发中要用到的所有标准和参考资料。
程序系统结构与关系
- 使用图表,详细列出本程序系统内的每个程序(包括每个模块和子程序)的名称、标识符以及它们之间的层次结构关系。
- 对于每个程序,给出其简短描述和功能概述。
程序设计与性能要求
- 逐个给出每个程序的详细设计考虑,包括程序的目的、意义、特点等。
- 明确程序的性能要求,如精度、灵活性和时间特性等。
- 针对每个输出项,详细描述其特性,包括名称、标识、数据类型和格式、有效范围、输出形式、数量和频度等。
- 详细说明所选用的算法,包括计算公式和计算步骤。
- 使用流程图、判定表等图表,表示程序的逻辑流程。
模块与子程序关系
- 用图的形式明确表示本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序。
- 说明参数赋值和调用方式。
- 描述与本程序直接相关的数据结构(数据库、数据文件)。
注释与文档
- 根据需要,详细说明本程序中安排的注释类型,如模块首部注释、分枝点注释、变量注释等。
- 描述对程序进行单体测试的计划,包括测试技术要求、输入数据、预期结果、进度安排等。
待解决的问题与考虑
- 列出在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
- 对设计的约束和限制条件进行说明,如管理方针、硬件限制、与其他应用间的接口要求等。
软件需求说明书
编写目的与预期读者范围
- 说明编写这份软件需求说明书的目的,并明确预期的读者范围。
系统概述与背景
- 描述待开发软件的名称及所属项目。
- 解释软件的用途、应用目标、作用范围,以及其他应向读者说明的有关该软件开发的背景材料。
- 如果软件产品是一项独立的软件,说明其自含性;如果为更大系统的一部分,则应说明与系统中其他各部分的之间的关系。
功能摘要与详细要求
- 为将要完成的软件功能提供一个摘要。
- 使用功能表或方框图等方式,详细描述软件的各种功能和它们之间的关系。
- 对每一类功能或每一个功能,具体描述其输入、加工和输出的需求。
接口需求
- 详细描述用户使用软件产品时的接口需求,如屏幕格式、报表或菜单的打印格式和内容等。
- 指定软件与其他软件产品或硬件的接口要求。
- 明确通信接口的需求和方式。
性能与数值需求
- 详细说明软件的静态和动态数值需求,如支持的终端数、处理的事务和任务的数量等。
- 用可度量的术语来叙述所有这些需求。
设计约束与标准
- 列出设计时受其他标准、规则、硬件限制等方面的影响。
- 指定由现有标准或规则派生的要求,如报表格式、数据命名等。
- 明确硬件配置的特点和各种约束下的软件运行要求。