xx概要设计说明书模板

xx概要设计说明书

文档版本号[通过批准的版本号]

编写人： 审核人： 批准人：

北京映翰通网络技术有限公司

修订记录：

修订日期 版本 描述 编写人

目录

1 1.1 1.2 1.3 1.4 2 2.1 2.2 2.3

引言 ................................................................... 2

编写目的 ............................................................ 2

背景 ................................................................ 2 定义 ................................................................ 2 参考资料 ............................................................ 2 总体设计 ............................................................... 2 系统功能 ............................................................ 2 系统结构 ............................................................ 3 系统设计 ............................................................ 3 2.3.1 包图设计......................................................... 3 2.3.2 类设计 .......................................................... 3 2.3.3 数据库设计描述 ................................................... 3 2.3.4 对象状态描述 ..................................................... 3 2.3.5 流程说明......................................................... 3 2.4 分解描述 ............................................................ 3 2.4.1 模块/子系统描述 .................................................. 3 2.4.2 数据设计......................................................... 3 2.5 依赖性描述 .......................................................... 4 2.6 接口描述 ............................................................ 4 2.6.1 用户接口......................................................... 4 2.6.2 外部接口......................................................... 4 2.6.3 内部接口......................................................... 4

3 3.1 3.2 3.3

数据结构设计 ........................................................... 4 数据定义 ............................................................ 4

数据格式 ............................................................ 4 数据存储 ............................................................ 4 3.3.1 逻辑设计......................................................... 5 3.3.2 物理设计......................................................... 5 3.3.3 ER图 ............................................................ 5 运行环境 ............................................................... 5 开发环境 ............................................................... 5 5.1 5.2

开发工具 ............................................................ 5 工程目录 ............................................................ 5 5.2.1 工程目录图....................................................... 5 5.2.2 工程目录描述 ..................................................... 5 系统出错处理设计 ....................................................... 5 6.1 6.2

出错信息 ............................................................ 5 补救措施 ............................................................ 6 系统维护设计 ........................................................... 6

4 5

6

7

1

引言

1.1 编写目的

说明编写这份概要设计说明书的目的，指出预期的读者。 1.2 背景

说明： a. 待开发软件系统的名称；

1.3 定义

列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料

列出有关的参考文件，如： a. 本项目的经核准的计划任务书或合同，上级机关的批文； b. 属于本项目的其他已发表文件； c. 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

2

总体设计

2.1 系统功能

     

GENERATE – to request server to generate a specific report RETRIEVE – to retrieve a specific report’s physical path information CANCEL – to cancel a job request if it is being queue on the server PRINT – to print a specific report to the printer LIST – to list all requests of a specific request type ENQUIRY – to enquire for a particular request information base on some criteria like client id or date 第 2 页 共 8 页 北京映翰通网络技术有限公司

2.2 系统结构 2.3 系统设计

在这里可以对各层所使用的技术做一个描述， 如，DAO层采用hibernate封装了所有对数据库的操作等

2.3.1 包图设计 2.3.2 类设计

2.3.3 数据库设计描述 2.3.4 对象状态描述

如果复杂的对象，需要描述对象状态 2.3.5 流程说明

描述系统架构模块之间的动态交互，来说明用例模型中典型用例场景。体现系统功能是如何实现的。 2.4 分解描述

本节描述系统中的子系统和模块。

2.4.1 模块/子系统描述

1、 简介 2、 功能列表

需要有序列图、执行过程描述、异常描述 2.4.2 数据设计

1、 数据实体描述 按照以下格式描述： 标识： 类型： 3 北京映翰通网络技术有限公司

目的：

2.5 依赖性描述

本节描述系统中的子系统，数据结构，模块，进程等设计实体间的关系。 依赖关系可以使用文字，结构图，（交互）事务图。

2.6 接口描述

2.6.1 用户接口

说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。 2.6.2 外部接口

说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与其他业务系统之间的接口关系。并定义接口测试级别（分高中低）。测试级别根据业务复杂度或技术难度来判断。 2.6.3 内部接口

说明本系统各个层或者模块之间接口方法。并定义方法测试级别（分高、中、低）。测试级别根据业务复杂度或技术难度来判断。 3

数据结构设计

3.1 数据定义

给出本系统内会使用的哪些主要数据对象 3.2 数据格式

指明本系统的数据对象的格式

3.3 数据存储

主是数据库表的定义及表关系 4 北京映翰通网络技术有限公司

3.3.1 逻辑设计 3.3.2 物理设计 3.3.3 ER图

4

运行环境

列出系统运行的环境及版本号 5

开发环境

5.1 开发工具

列出项目中使用的工具及版本号 5.2 工程目录

5.2.1 工程目录图

列出项目的工程目录图 5.2.2 工程目录描述

工程目录的详细说明 6

系统出错处理设计

6.1 出错信息

说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。 5 北京映翰通网络技术有限公司

6.2 补救措施

说明故障出现后可能采取的变通措施，包括： a. 后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术； b. 降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录； c. 恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。

7

系统维护设计

说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。 各个程序之间的对应关系，可采用如下的矩阵图的形式；

6 北京映翰通网络技术有限公司