详细设计说明书的主要内容及写作要求

详细设计说明书的主要内容及写作要求

编写目的

详细设计（又可称程序设计机）说明书编制的目的是说明一个软件系统各个层次中的每个程序（每个模块或子程序）的实际考虑，为程序员编写程序提供依据。

如果一个软件系统比较简单，层次很少，本文件可以不单独编写，和概要设计机说明书中不重复部分合并编写，文档名称为《软件设计说明书》。

主要内容及写作要求

详细设计说明书主要内容及写作要求如下：

1 引言

1.1 目的

说明编制本详细设计说明书的目的。

1.2 背景

列出本项目的任务提出者、项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展工作直接有关的人员和用户。

1.3 参考资料

A. 列出本项目经核准的任务书或合同和上级机关的批文。

B. 列出编写本设计说明书时参考的文件、资料、技术标准以及它们的作者、标题、编号、发布日期和出版单位等。

1.4 术语

列出本详细设计说明书中专门术语的定义和英文缩写词的原词组。

2．软件结构

用图表（常用系统流程图的层次结构表示）的形式列出本软件的各模块和程序单元的名称以及它们的相互关系。

3模块设计说明

3.1 模块n结构（n是模块序号）

将概要设计产生的功能模块进行细化，形成若干个可编程的程序单元（用图表形式给出程序单元的结构）。

3.2 算法

给出选用的算法和数学公式。

3.3 数据结构

用图表描述数据结构。

3.4 程序逻辑

用框图或过程性描述语言的形式表示各程序单元的控制流程（常用程序流程图表示）。

3.5 存储分配和数组分配

确定每个模块的存储量及数组定义。

3.6 单元说明

A. 程序单元标识；

B. 调用方式；

A.参数说明。

4、数据结构设计

4.1 数据结构与模块的关系

用图表描述数据结构与模块的关系。

4.2 逻辑机结构设计

列出所使用的数据结构中每个数据项、记录和文件的标识、定义、长度、及它们之间的关系。

给出所用数据库的数据模式。

4.3 物理结构设计

列出所使用的数据结构中每个数据项的存储要求、访问方法、存取单位和存取物理关系等。