项目设计说明

设计说明

目录

1 概述............................................................................................................................................. 1

1.1 编写目的 . ........................................................................................................................... 1

1.2 参考资料 . ........................................................................................................................... 1

1.3 术语和缩写词* . ................................................................................................................. 1

2 需求概述 . .................................................................................................................................... 1

3 结构设计 . .................................................................................................................................... 1

3.1 总体设计 . ........................................................................................................................... 1

3.2 接口设计* . ......................................................................................................................... 1

3.3 数据结构设计 . ................................................................................................................... 1

3.3.1 公共数据结构设计 . ................................................................................................ 1

3.3.2 数据库设计 . ............................................................................................................ 1

3.3.3 数据结构同程序的关系* . ...................................................................................... 1

3.4 出错处理设计* . ................................................................................................................. 2

3.5 其它* . ................................................................................................................................. 2

4 模块详细设计 . ............................................................................................................................ 2

4.1 模块1设计 . ....................................................................................................................... 2

4.1.1 功能说明 . ................................................................................................................ 2

4.1.2 算法 . ........................................................................................................................ 2

4.1.3 输入 . ........................................................................................................................ 2

4.1.4 输出 . ........................................................................................................................ 2

4.2 模块2设计 . ....................................................................................................................... 2

5 用户界面设计 . ............................................................................................................................ 2

【注】本编写指南中带有“*”标志的表示可选部分，即在文档编写过程中可以依据实际项目的具体情况进行取舍，文档完成后这些“*”标记应该去掉。

1 概述

1.1 编写目的

本文档的编写目的是：详细定义×××××软件的总体功能；给出系统的结构设计和过程设计，作为程序编写的依据。

1.2 参考资料

包括：

a. 项目来源；

b. 本文档中引用到的规范和资料等；

c. 列出这些规范和资料的作者、编号、标题、发表日期、出版单位或资料来源。

1.3 术语和缩写词*

列出本文档中用到的专门术语的定义和缩写词，缩写词要给出中文译名和英文全称，常用的不需要定义。

2 需求概述

概述系统的特性和需求，扩充软件需求说明中的信息，给出增加的细节，详尽地指出对软件需求说明中有关特性和需求作出的变更。（详细说明见《需求说明》）。

3 结构设计

3.1 总体设计

绘制软件模块结构图（Software Chart）。

对系统总体结构设计和所绘制图形加以文字说明。

3.2 接口设计*

对和硬件或其它外部系统的接口进行说明。

3.3 数据结构设计

3.3.1 公共数据结构设计

对程序当中所定义的全局变量、全局数据结构或类当中Public 数据结构进行定义和说明。

3.3.2 数据库设计

对程序当中所采用的数据库相关的名称和标识符、在数据库当中的位置、定义、度量单位、格式和值域、敏感程度、数据项名、缩写词和代码，包括用于数据库的规格说明等进行定义。建议给出数据库表结构。

3.3.3 数据结构同程序的关系*

数据结构影响最后的构件（模块）过程设计。因此，需要说明数据结构如何影响程序的数据组织、存取方式、结合程度和处理方法。

3.4 出错处理设计*

包括对出错输出信息、出错处理对策的说明。

3.5 其它*

说明设计当中对于安全保密、维护等情况的设计考虑。

4 模块详细设计

对系统当中主要的模块逐一进行说明。

4.1 模块1设计

4.1.1 功能说明

用文字形式简单的描述本构件（模块）完成的主要功能和输入输出接口。

4.1.2 算法

详细描述构件（模块）的实现算法，可以采用用流程图、盒(N－S) 图、PAD 图、HIPO 图、判定表及PDL 语言等手段进行描述。

4.1.3 输入

说明输入。

4.1.4 输出

说明输出。

4.2 模块2设计

„„

其它模块的设计要求同上说明。

5 用户界面设计

采用用户界面原型（如VB 窗口），说明每个界面可以执行的功能，需要输入/输出的数据项，描述输入数据的输入形式和验证手段，以及对界面操作过程需要特别注意的地方进行说明。