概要设计说明书实例

概要设计说明书

一． 引言

1． 编写目的

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

2． 项目背景（略）

3． 定义

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

总体设计

接口设计

数据结构设计

运行设计

出错设计

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

4． 参考资料

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

二． 任务概述

1． 目标

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

2． 运行环境

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

3． 需求概述（略）

4． 条件与限制

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

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

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

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

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

三． 总体设计

1．处理流程

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

图八

总体处理流程图

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

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

图九 模块化与总体成本

3．功能分配

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

四． 接口设计

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

1． 外部接口（略）

2． 内部接口（略）

五． 数据结构设计

1． 逻辑结构设计

student_Info 学生基本信息表

class_Info 班级信息表格

course_Info 课程基本信息表

gradecourse_Info 年级课程设置表

result_Info 学生成绩信息表

user_Info 系统用户表

图十 数据库逻辑结构图表

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． 出错处理对策

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

八． 安全保密设计

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

九． 维护设计

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

 

第二篇：需求分析说明书、概要设计说明书、详细设计说明书部分样例

需求分析说明书、概要设计说明书、详细设计说明书部分样例

作者：rjgczj 出处：csai论坛

以下是需求分析说明书、详细设计说明书、概要设计说明书样例，需要的朋友来信联系。rjgczj@

XX系统概要设计说明书

目录

1. 文档介绍 1

1.1 文档目的 1

1.2 文档范围 1

1.3 读者对象 1

1.4 参考文献 1

1.5 术语与缩写解释 1

2. 系统概述 2

3. 设计约束 2

3.1需求约束 2

3.2隐含约束 2

4. 设计策略 3

4.1扩展策略 3

4.2复用策略 3

4.3折衷策略 3

5．系统总体结构 3

5.1、系统总体结构 3

5.2、子系统功能及接口 4

6. 子系统的结构与功能 5

6.1、TERMSERV 5

7. 功能需求追溯 5

8. 环境的配置 5

9．其它 6

附录 6

A、 与主机接口 6

B、与终端接口 6

1. 文档介绍

1.1 文档目的

编写该文档的目的在于从总体设计的角度明确xxxx系统的功能和处理模式，明确与银联的接口，使系统开发人员和产品管理人员明确产品功能，可以有针对性的进行系统开发、测试、验收等各方面的工作。

1.2 文档范围

1.3 读者对象

该文档的读者为用户代表、软件分析人员、开发管理人员和测试人员。

1.4 参考文献

《xxxx系统需求说明书》

1.5 术语与缩写解释

无

2. 系统概述

XX系统是以触摸屏为主要交互工具，帮助用户以自助方式做业务查询。本系统的主要功能包括：话费查询、新业务介绍、网点分布查询、自助终端分布查询、电信新闻、交易监控、设备维护和监控等。本系统的设计目标是保证系统可以7*24小时安全、高效无故障运行；业务人员可以轻松完成设备和交易的监控、管理工作；报表种类齐全，可以满足业务人员各种帐务需求。

3. 设计约束

3.1需求约束

* 本系统应当遵循的标准

数据命名的规则遵循《C语言编程规约》中相关的规定；

* 软、硬件环境

本系统共包括联机处理和系统监控2大模块。

联机模块基于C/S结构，采用AIX操作系统，informix数据库，用ESQL/C语言开发，服务器采用PC SERVER；

监控模块基于B/S结构，采用WIN9X/2000/XP操作系统，使用ASP.NET开发。

* 接口/协议

系统与自助终端和电信主机之间的通讯使用TCP/IP协议；

与自助终端的接口见附录A、与自助终端接口

与电信主机的接口见附录B、与电信接口

* 用户界面

监控部分使用WINDOWS图形化界面，保证中专以上文化程度的人员可以无障碍操作。

* 软件质量

正确性：系统必须交易能够被正确处理；

健壮性：系统应能够7*24小时无故障运行；

效率：系统可以支持100个终端同时发起交易，处理交易的时间不超过10秒钟；

易用性：监控界面应采用图形化操作方式，便于业务人员操作；

安全性：报文中的关键数据域以密文的方式传输；

可扩展性：应该充分考虑到将来交易的修改或增加，避免需求变更时大规模修改程序；

3.2隐含约束

使用监控管理功能的人员是银行的业务人员，他们具有较强的业务技能和基本的电脑知识，对他们提供的操作界面应保证他们经过简单培训后无障碍的操作；

报表应该可以在多种操作系统上浏览、打印；

系统应提供审记追踪功能；

应该把有可能变动的参数存放到配置文件或数据库中，保证修改参数的灵活性。

4. 设计策略

4.1扩展策略

该系统是事务处理型系统，将来功能的扩展主要是指增加新的交易。为了方便本系统在将来扩展功能，在做系统设计时应采取如下策略：

为了保证增加新的功能或接口变更时程序改动规模最小化，应该使用报文格式配置文件解析、组织报文； 为了保证系统的灵活性，应该把可变参数保存到配置文件中；

XX系统详细设计说明书

目录

第一章 引言 1

1.1 概述 1

1.2 背景 1

1.3 定义 1

1.4 参考资料 1

1.5 术语与缩写解释 1

2. 程序结构 2

2.1 模块汇总表 2

3. 程序设计说明 2

3.1 终端通讯子系统 2

3.1.1 子系统功能说明 2

3.1.2 子系统流程图 3

3.1.3 子系统模块设计说明 5

4. 数据结构设计 5

4.1 终端档案表 TERMFILE 5

5. 接口设计 5

5.1 与自助设备接口 5

5.2 与主机接口 6

5.3 内部接口 6

第一章 引言

1.1 概述

编写

XX产品详细设计说明书的目的在于从详细设计的角度明确XX项目的业务品种、功能范围，明确与业务主机/终端系统的接口和业务处理模式，使系统开发人员和产品管理人员明确产品功能，可以有针对性的进行系统开发、测试、验收等各方面的工作。

1.2 背景

系统名称：XX系统

任务提出者：XXX

开发者：XX部门

用户：XX电信

1.3 定义

1.4 参考资料

《项目开发计划书》

《产品需求分析说明书》

《系统总体设计说明书》

1.5 术语与缩写解释

2. 程序结构

2.1 模块汇总表

终端通讯子系统模块名称功能简述readdata接收终端请求报文writelog把报文写入日志setsockscoket设置解析/组织报文以及报文分流模块名称功能简述unpack_c解析终端请求报文printstruct_c输出解吸后的报文checkpackage报文合法性检查pack_c组织应答报文：：：：

3. 程序设计说明

3.1 终端通讯子系统

3.1.1 子系统功能说明

建立TCP/IP 服务器侦听从来自自助设备端的连接请求。

为一个侦听到的连接创建一个进程，负责该连接上的接收和发送，并将接收和发送的原始数据写入LOG文件。

将接收到的数据送到队列1，从队列2取数据进行用于发送。

实现子系统功能程序列表：

termserv.c

子系统接口描述:

输入：终端请求报文、解析/组织报文以及报文分流模块产生的应答报文

输出：向解析/组织报文以及报文分流模块输出终端请求报文、向终端输出应答报文、向日志文件输出接收到的数据

3.1.2 子系统流程图

第一章 引言.... 1

1.1 编写目的... 1

1.2 项目背景... 1

1.3 基本定义... 1

第二章 产品概述.... 2

2.1 系统功能... 2

2.2 运行环境... 2

2.3 用户的特点... 2

2.3 条件与限制... 2

第三章 功能需求.... 3

3.1 功能划分... 3

3.2 功能描述... 3

4.3 软件接口... 4

4.4 故障处理... 4

第四章 其它需求.... 5

4.1 应用环境... 5

4.2 其它要求... 5

第一章 引言

1.1 编写目的

编写该文档的目的在于明确XX系统的用户需求，使得软件开发人员与用户对待开发软件的需求有统一的、无二义性的认识。该文档所描述的内容，可作为软件确认测试的依据。该文档的读者为用户代表、软件分析人员、开发管理人员和测试人员。

1.2 项目背景

见《XX项目启动会议记要》

1.3 基本定义

第二章 产品概述

2.1 系统功能

序号

功能名称

优先级

简要描述

1联机功能

高

解决实时交易问题

2管理监控功能

高

解决终端日常维护问题

2.2 运行环境

软件平台：服务器为AIX UNIX 4.3.3操作系统、informix数据库；

监控端为WINDONS 98/2000/XP操作系统。

硬件平台：服务器为IBM RS6000系列主机；

监控端为PC机。

2.3 用户的特点

由于使用自助终端的人员是广大市民，所以自助终端的操作界面应满足初中以上文化程度的人无障碍的操作；

使用监控管理功能的人员是业务人员，他们具有较强的业务技能和基本的电脑知识，对他们提供的操作界面应保证他们经过培训后无障碍的操作。

2.3 条件与限制

本次开发的期限为2002-2-5开始，2002-3-5结束；

议采用SOCKET通讯协议；

主机端的接口由主机端给出，不可更改；

与终端的接口由公司与终端厂家协商。