详细设计文档
[程序名称(填入你的程序名称)]
详细设计文档
填写时间
二零零九年八月
详细设计文档
目录
1
引言 .............................................. 3 1.1 1.2 1.3 1.4 2 3
编写目的 ....................................................... 3 背景 ........................................................... 3 定义 ........................................................... 3 参考资料 ....................................................... 3
程序系统的结构 ....................................... 3 程序设计说明 ........................................ 3 3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10
概述 ........................................................... 4 功能 ........................................................... 4 输入项 ......................................................... 4 输出项 ......................................................... 4 算法 ........................................................... 4 流程逻辑 ....................................................... 4 条件 ....................................................... 4 实施方案 ....................................................... 5 尚未解决的问题 ................................................. 5 运行环境及配置说明 ........................................... 5
4 程序2设计说明 ....................................... 5
详细设计文档
1 引言
1.1 编写目的
说明编写这份详细设计说明书的目的,指出预期的读者。
1.2 背景
说明:
待开发软件系统的名称;
本项目的任务提出者、开发者、用户和运行该程序系统的逻辑和物理节点。
1.3 定义
列出本文件中用到专门术语的定义和外文首字母组词的原词组。
1.4 参考资料
列出有关的参考资料,如: 属于本项目的其他已发表的文件;
本文件中各处引用到的文件资料,包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位,说明能够取得这些文件的来源。
2 程序系统的结构
用一系列图表列出本程序系统内的每个程序(包括每个模块和子程序)的名称和它们之间的层次结构关系。
3 程序设计说明
从本章开始,逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块,尤其是层次比较低的模块或子程序,其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同,在这种情况下,只要简单地说明这一点即可。
详细设计文档
3.1 概述
给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且,还要说明本程序的特点(如 是常驻内存还是非常驻?是顺序处理还是并发处理等)。
3.2 功能
说明该程序应具有的功能,可采用IPO图(即输入一处理一输出图)的形式。
3.3 输入项
给出对每一个输入项的特性,包括名称、位置、数据的类型和格式、各个数据值的有效范围、输入的方式等等【包括数据库中相关数据表,配置文件不在此进行说明,在3.10运行环境及配置说明进行说明】。对于画面显示部分,以单幅画面为单位进行组织,同时每一项输入数据的增加展现形式说明。
3.4 输出项
给出对每一个输出项的特性,包括名称、位置、数据的类型和格式,数据值的有效范围等等。【按文件依次进行格式说明】
3.5 算法
详细说明本程序所选用的算法,具体的计算公式和计算步骤。
3.6 流程逻辑
用图表(例如流程图等)辅以必要的说明来表示本程序的逻辑流程。对于画面显示程序本节说明画面的组织结构和关联关系。
3.7 条件
说明本程序运行中所受到的条件,主要包括单节点是否允许多实例运行、多节点的允许规模、内部数组支持最大维数,程序内部固定信息说明(可能与其他程序冲突的部分,如文件、网络端口等信息)。
详细设计文档
3.8 实施方案
说明对本程序进行开发的详细计划,包括对程序模块的划分、各模块工作量、进度安排、人员职责及单元测试等内容。
3.9 尚未解决的问题
说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。以及软件实现过程中简化处理的部分模块以及尚未完全实现的部分模块功能。
3.10 运行环境及配置说明
说明对本程序的运行环境,主要包括启动参数、运行目录配置、配置文件及说明。
4 程序2设计说明
用类似的方式,说明第2个程序乃至第N个程序的设计考虑。