软件项目的详细设计.pdfVIP

.

目录

一、详细设计文档模板.1

二、项目案例.2

详细设计文档

详细设计文档是指在详细设计过程中制订详细设计报告所依据的标准。一般说，详细设

计规格说明没有统一的标准，有的是以伪代码的方式体现，最后可能与源代码合为一体，有

的可能是一些文档格式的。下面的详细设计规格说明文档模板可以作为参照。

一、详细设计文档模板

1、导言

1.1目的

说明文档的目的。

1.2范围

说明文档覆盖的范围。

1.3缩写说明

定义文档中所涉及的缩写语（若无则填写无，不写）。

1.4术语定义

定义文档中所涉及的特定术语（若无则填写无，不写）。

1.5引用标准

列出文档制定所依据、引用的标准（若无则填写无，不写）。

1.6参考资料

列出文档制定所需的参考资料（若无则填写无，不写，也可以放在最后写）。

1.7版本更新信息

记录文档版本修改的过程，具体版本更新记录如表X—XXX所示。

表X—XXX版本更新记录

修改编号修改日期修改后的版本修改位置修改内容描述

2、系统设计概述

本节描述的主要内容包括：

（1）简要描述系统整体结构（文字和框图相结合）。

（2）模块划分和分布（如果采用OO技术，则可用构件图和包图表示）。

（3）系统采用的技术和实现方法。

；.

.

3、详细设计概述

本节以模块为单位，简要描述以下内容：

（1）模块用途。

（2）模块功能。

（3）特别约定。

4、详细设计

本节以模块为单位，详细描述以下内容：

（1）模块的定义。

（2）模块的关联。

（3）输入/输出数据说明，包括变量的描述（重要的变量及用途），以及约束条件或限

制条件。

（4）实现描述/算法说明，包括说明本模块的实现流程，包括条件分支和异常处理、模

块的应用逻辑、模块的数据逻辑。

这部分可以通过流程图或者伪代码的方式实现。

5、程序提交清单

程序提交清单以模块为单位分别进行描述，格式如表X—XXX所示。

模块文件名文件类型用途

———————————————————————————————————————

二、项目案例

项目案例名称：综合信息管理平台

项目案例文档：《综合信息管理平台详细设计说明书》

1、导言（可以不写）

1.1目的

本文档的目的是描述综合信息管理平台项目的详细设计，其主要内容包括系统功能简

介、系统详细设计、各个模块的三层划分、最小模块组件的伪代码。

本文档的预期读者是设计人员、开发人员、项目管理人员、测试人员。

1.2范围

该文档定义了系统的各个模块和模块接口，但未确定单元的具体实现，这部分内容将在

实现（编码）中确定。

1.3引用标准（参照学校要求写）

1、企业文档格式标准V1.1，北京长江软件有限公司。

2、

1.4参考资料

；.

.

1、

1.5版本更新信息

本文档版本更新记录如表X-XXX所示。

表X-XXX版本更新记录

修改编号修改日期修改后的版本修改位置修改内容概述