xx概要设计说明书

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

编写人：

审核人：

批准人：

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

修订记录：

目录

1.... 引言. 3

1.1     编写目的. 3

1.2     背景. 3

1.3     定义. 3

1.4     参考资料. 3

2.... 总体设计. 3

2.1     系统功能. 3

2.2     系统结构. 4

2.3     系统设计. 4

2.3.1     包图设计. 4

2.3.2     类设计. 4

2.3.3     数据库设计描述. 4

2.3.4     对象状态描述. 4

2.3.5     流程说明. 4

2.4     分解描述. 4

2.4.1     模块/子系统描述. 4

2.4.2     数据设计. 4

2.5     依赖性描述. 5

2.6     接口描述. 5

2.6.1     用户接口. 5

2.6.2     外部接口. 5

2.6.3     内部接口. 5

3.... 数据结构设计. 5

3.1     数据定义. 5

3.2     数据格式. 5

3.3     数据存储. 6

3.3.1     逻辑设计. 6

3.3.2     物理设计. 6

3.3.3     ER图. 6

4.... 运行环境. 6

5.... 开发环境. 6

5.1     开发工具. 6

5.2     工程目录. 6

5.2.1     工程目录图. 6

5.2.2     工程目录描述. 6

6.... 系统出错处理设计. 7

6.1     出错信息. 7

6.2     补救措施. 7

7.... 系统维护设计. 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.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、 数据实体描述

按照以下格式描述：

标识：

类型：

目的：

2.5  依赖性描述

本节描述系统中的子系统，数据结构，模块，进程等设计实体间的关系。

依赖关系可以使用文字，结构图，（交互）事务图。

2.6  接口描述

2.6.1   用户接口

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

2.6.2   外部接口

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

2.6.3   内部接口

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

3  数据结构设计

3.1  数据定义

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

3.2  数据格式

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

3.3  数据存储

主是数据库表的定义及表关系

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  出错信息

说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。

6.2  补救措施

说明故障出现后可能采取的变通措施，包括：

a.  后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；

b.  降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；

c.  恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。

7  系统维护设计

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

第二篇：概要设计说明书模板

概要设计说明书

一． 引言

1． 编写目的

从该阶段开发正式进入软件的实际开发阶段，本阶段完成系统的大致设计并明确系统的数据结构与软件结构。在软件设计阶段主要是把一个软件需求转化为软件表示的过程，这种表示只是描绘出软件的总的概貌。本概要设计说明书的目的就是进一步细化软件设计阶段得出的软件总体概貌，把它加工成在程序细节上非常接近于源程序的软件表示。

2． 项目背景（略）

3． 定义

在该概要设计说明书中的专门术语有：

总体设计

接口设计

数据结构设计

运行设计

出错设计

具体的概念与含义在文档后将会解释。

4． 参考资料

<软件工程概论> 李存珠 李宣东 编著 南京大学计算机系出版 20xx年8月

二． 任务概述

1． 目标

该阶段目的在于明确系统的数据结构和软件结构，此外总体设计还将给出内部软件和外部系统部件之间的接口定义，各个软件模块的功能说明，数据结构的细节以及具体的装配要求。

2． 运行环境

软件基本运行环境为Windows环境。

3． 需求概述（略）

4． 条件与限制

为了评价该设计阶段的设计表示的“优劣程度”，必须遵循以下几个准则：

1.软件设计应当表现出层次结构，它应巧妙地利用各个软件部件之间的控制关系。

2.设计应当是模块化的，即该软件应当从逻辑上被划分成多个部件，分别实现各种特定功能和子功能。

3.设计最终应当给出具体的模块（例如子程序或过程），这些模块就具有独立的功能特性。

4.应当应用在软件需求分析期间得到的信息，采取循环反复的方法来获得设计。

三． 总体设计

1．处理流程

系统的总体处理数据流程如下图：

图八总体处理流程图

2．总体结构和模块外部设计

模块是软件结构的基础，软件结构的好坏完全由模块的属性体现出来，把软件模块化的目的是为了降低软件复杂性，使软件设计，测试，调试，维护等工作变得简易，但随着模块数目的增加，通过接口连接这些模块的工作量也随之增加。从这些特性可得出如图九的一条总的成本（或工作量）曲线，在考虑模块化时，应尽量使模块数接近于图中的M，它使得研制成本最小，而且应尽量避免不足的模块化或超量。

图九模块化与总体成本

3．功能分配

从程序的结构中可以看出，学生的信息输入输出功能是由学生管理系统进行的。课程的信息输入输出是由课程管理系统进行的，而班级的信息流动则是班级管理系统进行的。

四． 接口设计

由于系统的各种内外部接口是通过借助数据库开发软件来实现的，是完全在数据库内部操作的，故在此略过此内容。

1． 外部接口（略）

2． 内部接口（略）

五． 数据结构设计

1． 逻辑结构设计

student_Info 学生基本信息表

列名 数据类型 可否为空 说明

student_ID INT(4) NOT NULL 学生学号（主键）

student_Name CHAR(10) NULL 学生姓名

student_Gender CHAR(2) NULL 学生性别

born_Date DATETIME(8) NULL 出生日期

class_No INT(4) NULL 班号

tele_Number CHAR(10) NULL 联系电话

ru_Date DATETIME(8) NULL 入校时间

address VARCHAR(50) NULL 家庭住址

comment VARCHAR(200) NULL 注释

class_Info 班级信息表格

列名 数据类型 可否为空 说明

class_No INT(4) NOT NULL 班号(主键)

grade CHAR(10) NULL 年级

Director CHAR(10) NULL 班主任

Classroom_No CHAR(10) NULL 教室

course_Info 课程基本信息表

列名 数据类型 可否为空 说明

course_No INT(4) NOT NULL 课程编号(主键)

course_Name CHAR(10) NULL 课程名称

course_Type CHAR(10) NULL 课程类型

course_Des CHAR(50) NULL 课程描述

gradecourse_Info 年级课程设置表

列名 数据类型 可否为空 说明

grade CHAR(10) NULL 年级

course_Name CHAR(10) NULL 课程名称

result_Info 学生成绩信息表

列名 数据类型 可否为空 说明

exam_No CHAR(10) NOT NULL 考试编号

student_ID INT(4) NOT NULL 学生学号

student_Name CHAR(10) NULL 学生姓名

class_No INT(4) NULL 学生班号

course_Name CHAR(10) NULL 课程名称

result FLOAT(8) NULL 分数

user_Info 系统用户表

列名 数据类型 可否为空 说明

user_ID CHAR(10) NOT NULL 用户名称（主键）

user_PWD CHAR(10) NULL 用户密码

user_DES CHAR(10) NULL 用户描述

图十数据库逻辑结构图表

2． 物理结构设计

系统的物理结构具体由数据库来设计与生成，此处略。

3． 数据结构与程序的关系

系统的数据结构由标准数据库语言SQL生成。

具体的例如创建系统用户表格 user_Info的程序用SQL表示就是：

CREATE TABLE[dbo].[user_Info](

[user_ID][char](10)COLLATE Chinese_PRC_CI_AS NOT NULL,

[user_PWD][char](10)COLLATE Chinese_PRC_CI_AS NULL,

[user_Des][char](10)COLLATE Chinese_PRC_CI_AS NULL ) ON [PRIMARY]

六． 运行设计

1． 运行模块的组合

具体软件的运行模块组合为程序多窗口的运行环境，各个模块在软件运行过程中能较好的交

换信息，处理数据。

2． 运行控制

软件运行时有较友好的界面，基本能够实现用户的数据处理要求。

3． 运行时间

系统的运行时间基本可以达到用户所提出的要求。

七． 出错处理设计

1． 出错输出信息

在用户使用错误的数据或访问没有权限的数据后，系统给出提示：“对不起，你非法使用数据，没有权限！”而且用户的密码管理可以允许用户修改自己的密码，不允许用户的匿名登录。

2． 出错处理对策

由于数据在数据库中已经有备份，故在系统出错后可以依靠数据库的恢复功能，并且依靠日志文件使系统再启动，就算系统崩溃用户数据也不会丢失或遭到破坏。但有可能占用更多的数据存储空间，权衡措施由用户来决定。

八． 安全保密设计

系统的系统用户管理保证了只有授权的用户才能进入系统进行数据操作，而且对一些重要数据，系统设置为只有更高权限的人员方可读取或是操作。系统安全保密性较高。

九． 维护设计

由于系统较小没有外加维护模块，因为维护工作比较简单，仅靠数据库的一些基本维护

本文来自CSDN博客，转载请标明出处：/hackbomb2008/archive/2008/02/22/2113849.aspx