概要设计说明书模板
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
概要设计说明书模板
篇一:概要设计说明书模板
XXX项目
概要设计说明书
公司实施部门:项目经理:生效日期:
(文档编号:)
目录
1. 编制目的 ................................................ ................................................... ........ 错误!未定义书签。
2. 适用范围 ................................................ ................................................... ........ 错误!未定义书签。
3. 文件说明 ................................................ ................................................... ........ 错误!未定义书签。
1. 概述 ................................................ ................................................... . (3)
1.1 1.2 1.3 1.4 1.5
系统简
介 ................................................ ................................................... .............................. 3 系统目标 ................................................ ................................................... .............................. 3 系统设计原则 ................................................ ................................................... ...................... 3 系统运行环境 ................................................ ................................................... ...................... 3 开发环境 ................................................ ................................................... (3)
2. 总体结构 ................................................ ................................................... ......................................... 3 2.1
系统部署 ................................................ ...................................................
(3)
系统拓扑结构 ................................................ ................................................... .. (3)
2.1.2 系统部署说明 ................................................ ................................................... .............. 4 2.2 软件部署 ................................................ ................................................... (4)
3. 数据流程 ................................................ ................................................... ......................................... 4 3.1 3.2 3.3
数据流程图 ................................................ ................................................... .......................... 4 数据流程图说明 ................................................
.................. 4 数据字典 ................................................ ................................................... (4)
2.1.1
4. 系统模块设计................................................. ................................................... ................................. 4 4.1 4.2
子系统模块结构图 ................................................ ................................................... .............. 4 子系统模块概要设计 ................................................ ................................................... . (4)
5. 数据库设计 ................................................ ................................................... ..................................... 5 5.1 5.2
结构概
................................................... .............................. 5 表结构 ................................................ ................................................... . (5)
6. 永久性数据结构................................................. ................................................... ............................. 6 6.1 6.2 6.3
文件组织结构 ................................................ ................................................... ...................... 6 文件结构 ................................................ ................................................... .............................. 6 数据备份、恢复 ................................................ ................................................... (6)
7. 系统业务功能设计.................................................
......................... 6 7.1 7.2
业务内容 ................................................ ................................................... .............................. 7 处理流程 ................................................ ................................................... (7)
8. 其它设计 ................................................ ................................................... ......................................... 7 9. 术语表 ................................................ .................(原文来自:小草范文网:概要设计说明书模板)................................................ . (7)
XXX项目概要设计说明书
文档编号:版本:
1. 概述 1.1 系统简介
简要描述本系统基本情况。
1.2 系统目标
描述概要设计所要实现的目标,包括功能目标、性能目标等。
1.3 系统设计原则
列举系统设计时遵循的基本理论或基本原则,例如面向对象的系统分析原则、逐步求精原则等。
根据用户需求和系统设计原则,对设计要点进行优先级排序(注:一定要分出优先次序,不能有任何两项平级),要点可包括:体积大小size、速度speed、可靠性robustness、安全性safety、易测试性testability、易维护性maintainability、可复用性reusability、可移植性portability等。
1.4 系统运行环境
包括对硬件平台、操作系统、数据库系统、中间件平台、编程平台、网络和外围设备、网络传输介质和网络协议的描述。
对于B/S或C/S结构需要分别指出各部分的运行环境。
1.5 开发环境
列举项目组进行系统分析、程序设计和程序开发时要使用的工程工具和开发语言。
应描述每一工具软件的名称、版本等。
2. 总体结构 2.1 系统部署
2.1.1 系统拓扑结构图
以图形方式给出该软件产品在用户方部署时,预期的网络和硬件部署结构,以及系统和其他系统间的部署关系等。
涉及网络结构时,建议使用网络拓扑图方式描述。
对软件运行时需要配置的计算机或其他外部设备,均应以图形方式加以描述。
2.1.2 系统部署说明
对上面的系统部署图中每个系统设备的功能加以必要的描述,说明该设备的基本配置要求,其上运行的操作系统名称和版本,应用程序的名称和版本等。
2.2 软件部署
描述应用软件体系部署,可以包括设计思想、部署图、软件架构说明、层次结构等方面。
3. 数据流程 3.1 数据流程图
以图形方式描述系统整体的数据流转情况及数据处理行为,数据流程图格式应符合软件工程的一般标准。
3.2 数据流程图说明
对上面的数据流程图中每个数据流转或数据处理环节加以必要的解释和说明。
3.3 数据字典
4. 系统模块设计 4.1 子系统模块结构图
以图形方式给出软件系统的子系统(或软件包)划分,模块划分,子系统间、模块间关系等。
结构图格式应符合软
件工程的一般标准。
(注意:一般应在系统结构中包含“发布子系统”,即通常所说的安装程序或其他形式的发布程序,在下面的“子系统模块概要设计”中也应包含“发布子系统”的概要设计说明。
)
4.2 子系统模块概要设计
对“子系统模块结构图”中出现的每个子系统或模块,描述以下内容:
? 名称和版本。
? 子系统或模块的内部编号(编号格式由项目组自定)。
? 表现形式(以何种形式运行,如服务程序、应用程序、COM组件、数据库脚本、JSP程序
等等)。
? 功能描述。
? 处理流程图(对较简单的模块,在前面“功能描述”中已可以准确定义该模块功能的,可
省略功能流程图)
? 子系统模块有无人机交互界面,如有,则给出该子系统-模块人机交互界面的类型(如普通
Web界面、普通GUI界面、Java Applet界面、Java Swing 界面、字符终端界面、命令行界
面等)和设计原则(界面风格、基本操作方式等)。
? 与其他子系统或模块的接口(描述每个接口的名称、输入信息、输出信息、异常处理等)。
? 实现方式(以何种开发工具,何种开发语言实现该子系统或模块)。
? 实现思路(给出实现该模块的基本思路,包括对模块内部结构、算法、编程方法等的初步
设想)。
5. 数据库设计
此节描述存储在通用数据库中的数据,或存储在硬盘、磁带、光盘等永久性存储介质上,但存储格式与通用数据库相同的数据。
如果系统不以数据库方式存储数据,则此节可省略。
5.1 结构概要
描述数据库的系统设置、表空间分配、用户权限设置等概要信息。
5.2 表结构
必要时,可用单独的文档(如,《XXX数据库结构设计》)来描述数据库设计。
对不需要单独的文档来描述数据库设计的,对系统使用的每一种数据库表或数据库视图,给出下面的表格,描述其内部结构:
篇二:软件系统概要设计说明书模板
概要设计说明书
1.引言
1.1 编写目的
在本机票预定系统项目的前一阶段,也就是需求分析阶段中,已经将系统用户对本系统的需求做了详细的阐述,这些用户需求已经在上一阶段中对航空公司、各旅行社及机场的实地调研中获得,并在需求规格说明书中得到详尽得叙述及阐明。
本阶段已在系统的需求分析的基础上,对机票预定系统做概要设计。
主要解决了实现该系统需求的程序模块设计问题。
包括如何把该系统划分成若干个模块、决定各个模块之间的接口、模块之间传递的信息,以及数据结构、模块结构的设计等。
在以下的概要设计报告中将对在本阶段中对系统所做的所有概要设计进行详细的说明。
在下一阶段的详细设计中,程序设计员可参考此概要设计报告,在概要设计对机票预定系统所做的模块结构设计的基础上,对系统进行详细设计。
在以后的软件测试以及软件维护阶段也可参考此说明书,以便于了解在概要设计过程中所完成的各模块设计结构,或在修改时找出在本阶段设计的不足或错误。
1.2 项目背景
本项目(机票预定系统)时由航空公司委托,由负责开发。
机票预定系统将由两部分组成:置于个旅行社定票点的前台客户程序,以及置于
1.3.1 专门术语
SQL SERVER: 系统服务器所使用的数据库管理系统(DBMS)。
SQL: 一种用于访问查询数据库的语言
事务流:数据进入模块后可能有多种路径进行处理。
主键:数据库表中的关键域。
值互不相同。
外部主键:数据库表中与其他表主键关联的域。
ROLLBACK: 数据库的错误恢复机制。
1.3.2 缩写
系统:若未特别指出,统指本机票预定系统。
SQL: Structured Query Language(结构化查询语言)。
ATM: Asynchronous Transfer Mode (异步传输模式)。
1.4 参考资料
以下列出在概要设计过程中所使用到的有关资料:1.机票预定系统项目计划任务书航空公司
2.机票预定系统项目开发计划《》软件开发小组1999/31999/3
3.需求规格说明书《》软件开发小组1999/3
4.用户操作手册(初稿)《》软件开发小组 1999/4 5.软件工程及其应用周苏、王文等天津科学技术出版社 1992/1
6.软件工程张海藩清华大学出版社 1990/11
7. Computer Prentice Hall 1996/01
文档所采用的标准是参照《软件工程导论》沈美明著的“计算机软件开发文档编写指南”。
2.任务概述
2.1 目标
2.2 运行环境
系统将由两部分程序组成,安装在各旅行社客户机上的客户程序及航空公司内的数据服务器程序。
根据调研得知所有旅行社的计算机配置均在Pentium 133级别以上,客户程序应能够在Pentium 133级别以上, Win NT环境下运行。
2.3 需求概述
航空公司为方便旅客,需开发一个机票预定系统。
为便于旅客由旅行社代替航空公司负责为旅客定票,旅行社把预定机票的旅客信息,包括姓名、性别、工作单位、身份证号码、旅行时间、旅行目的地,输入机票预定系统的客户端程序,系统经过查询航空公司内的航班数据服务器后,为旅客安排航班,印出取票通知。
旅客在飞机起飞前一天凭取票通知和帐单交款后取票,系统校对无误后即印出机票给旅客。
要求系统能有效、快速、安全、可靠和无误的完成上述操作。
并要求客户机的界面要简单明了,易于操作,服务器程序利于维护。
2.4 条件与限制
3.总体设计
3.1 处理流程
下面将使用(结构化设计)面向数据流的方法对机票预定系统的处理流程进行分析。
系统可分为两大部分:一、客户机上的程序,二、服务器上的程序。
以下将分别对系统的这两大部分进行流程分析:
3.1.1 客户机程序流程
客户机上的输入信息为旅客资料或帐单号,还包括一个定票/领票选项。
输出为打
下面对各模块(以数字表示)进行功能说明:
1.读入并确定(定票/领票)它是一个事务处理中心,若输入是定票时转入2 ,输
出则转入5。
2.读入旅客资料读取所输入的旅客资料,并将其格式化,将格式化数据送3。
3.检验输入资料检验格式化输入资料,初步检查输入是否有误,它是一个事务处理
中心,有误则转2再次读入,检查无误则将数据送4。
4.准备服务器数据由格式化旅客资料准备需发送到服务器的数据,将准备好的数据
送7。
5.读入帐单号读取所输入的帐单号,并将其格式化,
将格式化数据送6。
6.准备服务器数据由格式化帐单号准备需发送到服务器的数据,不同于4,它将准
备的是帐单号,将准备好的数据送7。
7.准备网络数据包将数据准备/加密成网络传输数据包。
8.网络数据发送将数据包经网络发送到服务器程序,它是程序与网络的接口。
9.网络数据接受接受由服务器程序经网络传送到客户机的数据包,它是程序与网络的接口。
10.解开/判断解开9 所接受的数据包,并判断数据是定票数据或是领票数据,它
是一事务处理中心,是定票则将数据送11,是领票则将数据送18。
11.定票成功?由数据判断定票是否成功,它是一事务处理中心,若定票成功则
将数据送12,不成功则将数据送15。
12.准备输出数据由接收的服务器数据准备输出数据,其中关于帐单的数据将送
入13,其他包括旅客资料等送入14。
13.打印帐单由帐单信息处理帐单格式并打印出帐单。
14.输出定位确定在屏幕上显示确定定位及其他信息。
15.判断错误由数据判断出错误类型,将类型送到16。
16.准备错误语句由具体错误类型准备错误语句,送17。
17.输出错误语句在屏幕上显示错误语句。
18.领票核对成功?由数据判断领票核对是否成功,它是一事务处理中心,若成
功则将数据送19,不成功则将数据送15。
19.准备机票输出数据由接收的服务器数据准备将打印的机票数据数,据其中关
于帐单的机票的数据将送入20,其他包括旅客资料等送入14。
20.打印机票由机票信息处理机票格式并打印出机票。
3.1.2 服务器程序流程
下面对各模块(以数字表示)进行功能说明:
1.网络数据接收接受由客户机程序经网络传送到客户机的数据包,它是程序与网
络的接口。
2.解开数据解开/解密打包的数据,并将恢复的数据格式化送入3。
3.判断操作由数据判断需要做什么数据库操作,它是一事务处理中心,若为定票操
作则将数据送4,若为领票操作则将数据送15。
4.准备数据库查询语句由定票数据准备访问SQL SERVER数据库所需的SQL 语
句,送入5。
5.数据库操作运行SQL 语句,查询并存入数据库,获得相应的定票数据,将数据
送入6。
它需包括初步对查询的判断。
它必须为乘客安排可抵达目的地的有座位的航班。
6.判断查询是否成功利用查询所得的数据判断定票是否成功,它是一事务处理中
心,若为定票操作成功则将数据送7,若不成功则将数据送8。
7.准备回送数据准备定票成功后需回送客户机程序的数据,送16。
8.确定原因由查询数据判断定票不成功的原因,送9。
9.准备回送数据根据不成功的原因,准备需送回客户机程序的数据,送入16。
10.准备数据库查询语句由领票数据准备访问SQL SERVER数据库所需的SQL
语句,送入11。
11.数据库操作运行SQL 语句,查询并存入数据库获得相应的领票数据,将数
据送入6。
它需包括初步对查询的判断。
12.判断查询是否成功利用查询所得的数据判断领票
是否成功,它是一事务处理
中心,若为领票操作得到确认则将数据送11,若不成功则将数据送8。
13.准备回送数据准备领票确认后需回送客户机程序的数据,送16。
14.确定原因由查询数据判断领票不能确认的原因,送15。
15.准备回送数据根据不成功的原因,准备需送回客户机程序的数据,送入16。
16.准备网络数据包将数据准备/加密成网络传输数据包。
17.网络数据发送将数据包经网络发送到服务器程序,它是程序与网络的接口。
以上显示的各模块数字相同的为同一模块;由于事务流处理上的便利,将有些功能模块,拆分到各事务流中。
3.2 总体结构和模块外部设计
下面以结构图来描述机票预定系统的软件总体结构。
框内注明了模块的名字;
方框之间的直线表示模块的调用关系。
3.2.1 客户机部分
篇三:软件概要设计说明书(模板)
概要设计说明书
1引言
1.1编写目的
说明编写这份概要设计说明书的目的,指出预期的读者。
1.2背景
说明:
a. 待开发软件系统的名称;
b. 列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站(中心)。
1.3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资料
列出有关的参考文件,如:
a. 本项目的经核准的计划任务书或合同,上级机关的批文;
b. 属于本项目的其他已发表文件;
c. 本文件中各处引用的文件、资料,包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。
2总体设计
2.1需求规定
说明对本系统的主要的输入输出项目、处理的功能性能要求,详细的说明可参见附录C。
2.2运行环境
简要地说明对本系统的运行环境(包括硬件环境和支持环境)的规定,详细说明参见附录C。
2.3基本设计概念和处理流程
说明本系统的基本设计概念和处理流程,尽量使用图表的形式。
2.4结构
用一览表及框图的形式说明本系统的系统元素(各层模块、子程序、公用程序等)的划分,扼要说明每个系统元素的标识符和功能,分层次地给出各元素之间的控制与被控制关系.
2.5功能器求与程序的关系
2.6人工处理过程
说明在本软件系统的工作过程中不得不包含的人工处理过程(如果有的话)。
2.7尚未问决的问题
说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。
3接口设计
3.1用户接口
说明将向用户提供的命令和它们的语法结构,以及软件的回答信息。
3.2外部接口
说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。
3.3内部接口
说明本系统之内的各个系统元素之间的接口的安排。
4运行设计
4.1运行模块组合
说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合,说明每种运行所历经的内部模块和支持软件。
4.2运行控制
说明每一种外界的运行控制的方式方法和操作步骤。
4.3运行时间
说明每种运行模块组合将占用各种资源的时间。
5系统数据结构设计
5.1逻辑结构设计要点
给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。
5.2物理结构设计要点
给出本系统内所使用的每个数据结构中的每个数据项的存储要求,访问方法、存取单位、存取的物理关系(索引、设备、存储区域)、设计考虑和保密条件。
5.3数据结构与程序的关系
说明各个数据结构与访问这些数据结构的形式:
6系统出错处理设计
6.1出错信息
用一览表的方式说朗每种可能的出错或故障情况出现时,系统输出信息的形式、含意及处理方法。
6.2补救措施
说明故障出现后可能采取的变通措施,包括:
a. 后备技术说明准备采用的后备技术,当原始系统数据万一丢失时启用的副本的建立和启动的技术,例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术;
b. 降效技术说明准备采用的后备技术,使用另一个效率稍低的系统或方法来求得所需结果的某些部分,例如一个自动系统的降效技术可以是手工操作和数据的人工记录;
c. 恢复及再启动技术说明将使用的恢复再启动技术,使软件从故障点恢复执行或使软件从头开始重新运行的方法。
6.3系统维护设计
说明为了系统维护的方便而在程序内部设计中作出的安排,包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。
各个程序之间的对应关系,可采用如下的
矩阵图的形式。