概要设计说明书模板.docx

概要设计说明书模板.docx

《概要设计说明书模板.docx》由会员分享，可在线阅读，更多相关《概要设计说明书模板.docx（15页珍藏版）》请在冰点文库上搜索。

概要设计说明书模板

XXXXXXXXX

概要设计说明书

XXXX年XX月XX日

文档编号：

XXXXXVVV-004-XXX

版本号：

V.VV

产品名称:

XXXXXXXXXXXXX

文档名称:

概要设计说明书

编写

XXXXXXXXXX

日期

XXXX/XX/XX

校对

XXXXXXXXXX

日期

XXXX/XX/XX

审核

XXXXXXXXXX

日期

XXXX/XX/XX

批准

XXXXXXXXXX

日期

XXXX/XX/XX

上海市浦东新区张江高科技园区郭守敬路498号

上海市201203

Phone3895458838954567Fax50801861

第一章引言

1.1编写目的

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

本概要设计说明书的编写目的是为了说明系统总体设计的技术方案，从程序系统的设计考虑，包括系统的基本处理流程、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等内容，以向整个设计期提供关于程序系统的逻辑和数据功能实现方式的总体描述，从而作为程序详细设计或编码的基础。

设计阶段将以本文档为核心文档。

本概要设计说明书的适用读者为：

软件开发者、测试人员}

1.2项目概况

{1.说明待开发的软件系统的名称

2.列出本项目的任务委托单位、开发单位、协作单位、用户单位

3.说明项目背景，叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。

如果本次开发的软件系统是一个更大的系统的一个组成部分，则要说明该更大系统的组成和介绍本系统与其它相关系统的关系和接口部分

4.保密说明：

本项为可选项，一般的软件公司都会要求对软件开发的概要设计文档进行保密，不允许被复制、使用和扩散到公司之外的范围，如果需要强调则允许做相关的保密说明

5.版权说明：

本项为可选项，若有必要，才要作有关的描述。

}

1.3术语定义

{列出本文档中所引用到的专门术语的定义和首字母缩写词、缩略语的原文，以便对概要设计说明书进行适当的解释}

1.4参考资料

{列出所本文档所使用的参考资料，包括：

A本软件开发所经核准的合同或标书或可行性报告等文档

B软件开发计划书

C需求分析报告

D测试方案（若存在初稿的话）

E与本项目有关的已发表的文件或资料

F本文件中各处引用的文件、资料，所采用的软件开发标准和规范

注意：

必须列出文件、资料的作者、标题、编号、发表日期和出版单位，以说明这些文件资料的来源。

若某些文档有保密要求的，则要说明其保密级别。

建议参考格式如下：

《开发手册》V2.0，复旦金仕达计算机有限公司，2001年8月6日，保密

《国泰君安系统方案书》复旦金仕达计算机有限公司，2001年2月，保密}

第二章系统概述

{概要地介绍本软件系统，只要求提供影响设计的一般因素，不必太详细地描述大量细节，本章主要目的仅仅是使本设计说明书更加易于理解，建议根据系统设计的实际需要可以有选择地从以下方面进行概要描述：

实现目标、条件与限制、运行环境、需求概述}

2.1实现目标

{说明完成本项目要达到的目标，可从以下几方面考虑设计：

A人力与设备费用的节省；

B处理速度的提高；

C控制精度或生产能力的提高；

D管理信息服务的改进；

E决策系统的改进；

F人员工作效率的提高；

G安全可靠性的保证；

等等}

2.2条件与限制

{为可选项，只要当软件系统的设计或开发受到某种特定的限制，或者可直接能影响系统设计的某种因素，这些因素可能成为系统的设计约束，他们的改变可能会影响某些需求的实现时，才需要做概要介绍。

若存在以下方面的系统约束或条件限制时，可以进行相关的阐明：

（但不限于这些）

1．为完成本软件系统应具备的特定条件、开发单位已具备的条件以及尚需创造的条件,如：

现阶段还未到位的设备、资源等需要做出相应的约束说明

2．必要时，还应说明用户及分合同承包者承担的工作、完成期限及其他条件与限制，如果用户及分合同承包者对系统的实现起到的某些作用会直接影响系统设计的成败则要特别说明

3．本系统的设计规范需要受到某些特定的行业规范的限制

4．本系统的开发需要受到用户对系统的工程化管理的某些特别的要求，包括用户规定对系统实现的全过程的变更规定

5．本系统设计工作所需的一些假定条件和必须满足的约束，如本功能的开发假定用户会熟练使用SQL语言，本功能的实现应该在某功能实现前开发完成等

6．本系统的设计可能需要使用的所有购入构件、所有适用的许可或使用限制，以及所有相关的兼容性及互操作性或接口标准的有关限制和规定}

2.3运行环境

{概要地说明本软件系统的运行环境的拓朴结构和布局，分别说明前、后台及网关或中间件的运行环境,应包括通讯条件、网络环境、硬件配置、软件系统等

其中硬件环境：

要求列出为运行本软件所要求的硬件最小配置：

a.处理器的型号、内存容量

b.所要求的硬盘空间、分区格式、相关的记录格式、设备的型号和数量、联机/脱机等

c.I/O设备（联机/脱机）

d.网络相关设备（型号、数量）}

支持软件：

说明为运行本软件所需要的支持软件，如

a.操作系统名称、对应的版本号、相关的ServicePackage

b.编译器和对应的版本号

c.数据库管理系统和对应版本号

d.其他支持软件

数据结构：

列出为支持本软件的运行所需要的数据库和相关参数

这里只要求概要的说明一下，以便帮助理解本概要设计说明书，可参考以下格式：

【前台】计算机：

IBMPC兼容机。

操作系统：

MicrosoftWindows95/97/98/2000/NT操作系统

数据库系统：

IBMDB2数据库系统（客户端）

应用软件：

国泰君安实时报警（客户端）

网络：

Ethernet,TCP/IP

【后台】计算机：

IBMRS/6000

操作系统：

IBMAIX操作系统

数据库系统：

IBMDB2数据库系统（服务端）

应用软件：

国泰君安实时报警中心（服务端）

网络：

Ethernet,TCP/IP}

2.4需求概述

{根据系统设计的实际需要，简要介绍系统的需求情况，不必详细描述需求的具体细节，只仅仅要求能够更好帮助理解本设计说明书的内容，建议有选择地从功能需求、性能需求和运行需求进行分别描述，对于直接影响系统设计的关键或主要功能、性能以及运行要求等方面进行概要介绍，如果性能和运行需求方面对设计影响不大，则允许不必说明

第三章总体设计

3.1设计原则

{介绍本系统的结构设计原则和总体设计指导思想，主要从系统设计实现的目标来考虑，比如：

处理速度、安全保密性、可扩展性等方面进行阐述，可以使用一些套话稍做修改即可。

建议参考以下范例进行描述：

数据实时性强

监控的实时性是不言而喻的。

无论实时检测还是动态显示交易汇总数据和盘中异常结果，都要求实时监控的算法尽量优化，处理简洁，这样才能真正达到实时监控的目的，为总部进行盘中稽核和及时处理异常情况提供有效的手段。

可扩充性强

由于交易业务是不断扩展的，监控的指标及功能都是不断扩大或变化的，故系统必须具有良好的可扩充性。

系统设计应尽可能结构化、模块化，并与其他子系统预留相应的接口。

可维护性好

由于证券市场、政策及其管理是随着整个国民经济的发展而变化的，要求对交易业务的实时监控具有相当的灵活性，以便于维护。

先进性

系统采用国际流行的开放式框架，主要软硬件设备符合国际标准，集成了90年代国际水平的主流生产厂的先进产品，应用软件采用C/S结构，网络用TCP/IP协议，这是90年代的大中型系统的普遍模式。

数据完整性、安全性高

财务系统数据的完整性和安全性是非常重要的。

一个安全的客户/服务器系统应该是客户端机器的任何操作都通过服务器来实现其一致性和完整性控制。

数据库及财务稽核系统本身都应提供分级授权、日志记录等手段来确保系统的安全。

}

3.2设计规范

｛说明可以引用公司现有的各种设计规范或各种软件开发的国家标准或规范，主要包括：

（不限于以下几种，也不指定）

A）命名约定

规定系统和子系统名,程序名,数据库表（文件）名,数据名,变量名等的编制规范。

B）界面约定

规定屏幕界面的总体布局，如菜单行、显示主体、图标按钮、提示信息、出错信息等规范化，统一风格。

C）程序编写规范

根据采用的编程工具特点，制定规范化要求，使程序易读易懂，可维护，可移植。

具体选用的规范，只要对设计有所帮助就可以罗列，A）、B）等编号及相关规范标题可以自行决定。

对于引用公司技术总部事先制订的有关规范或现存的各种国家标准等规范，则可以简单地描述，并参见《XXXXXXXX》规范或标准，文件可以作为本概要设计说明书的附件进行保存

如果一个系统比较大需要拆分成若干个子系统，而每个子系统需要各自编制概要设计文档，则只需要在一个总的概要设计说明书进行描述，其他子系统允许不专门进行描述，或注明参见《XXXXXXX》概要设计说明书。

｝

3.3系统设计描述

｛简要介绍系统的总体结构和概要功能，可以通过画系统设计总体框架结构图的方式，再附上简单的文字说明,对本软件系统的总体功能进行概要描述。

｝

第四章　模块结构设计

4.1系统划分及功能描述

｛说明本系统的系统元素（即各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能说明，分层次地给出各元素之间的控制与被控制的关系。

系统划分允许采用各种形式（如：

系统功能模块列表等）进行描述，最好建议用系统模块结构图表示，再附上简单的文字说明，以说明模块的层次结构以及相应的接口控制关系，有必要时可以简单介绍模块之间的调用关系，如下例范例所示：

（要求相应的功能模块最好要有一定的模块编号进行标识）

功能描述可以通过对系统划分中各个元素分别说明，概要说明各个元素所实现的功能或相关的业务处理流程｝

4.2　各功能模块的概要处理流程

{从本节开始描述各个功能模块的处理流程，建议每一个功能模块为单独一节，标题可以根据模块结构图中的模块划分情况自行决定。

描述系统中各个功能模块相应功能的全部细节，要求对每一个模块的设计都可以被实现，并能够被验证的，主要就是描述每一个模块的输入、输出和处理流程，必要时，可以借助数据流图来描述。

对于模块的设计描述，建议参照以下格式进行书写：

（建议加上模块编号的有关标识，编码规则由项目组自行制订）

功能

输入

处理

逻辑

输出

界面

数据

结构

备注

｝

第五章　数据结构设计

{对（全局）数据结构进行具体设计，以确定具体的数据项及其数据属性，如：

数据类型、长度及各种数据的约束条件等等，包括各种常量所用到的代码或常数信息，并详细描述各种代码的编码规则，以及有效值中只有有限的几个，则需要一一罗列，如果存在数据库，则要详细说明数据库的表划分以及各个字段的数据结构说明，必要时允许借助有关数据库设计CASE工具描述ER图模型的方式进行说明，也允许通过CASE工具自身的模板格式转成DOC文档后加入本章节内容，还可以用CASE工具产生的文档做为附件进行保存。

本章内容可以按照接口用数据结构和系统内部数据结构进行分节，也可以根据具体的数据库库表结构进行分节，标题根据设计需要自行确定。

关于数据结构的设计建议参照以下编写格式：

（如：

table和view）

当前库：

XXXXXXXXX

备份库：

XXXXXXXXX

历史库:

XXXXXXXXX

字段名称

类型

长度

代码

字段说明

null

idx

pk

fk

defautl

取值范围

}

第六章接口设计

{为可选项，若存在有关的接口并且需要特别说明，否则容易产生开发者对系统设计的二义性时需要详细描述。

接口分为外部接口和内部接口，其中外部接口如：

用户界面、软件接口与硬件接口等，内部接口如：

子系统之间的接口关系，模块之间的接口，主要是有关传递信息,参数等等。

本章若存在N个接口，则可分为N节来描述，每个接口单独为一节，标题可自行决定。

对于用户界面的设计可以为可选项，如果缺少有关界面的设计描述，将给开发人员带来对概要设计的二义性时则要求设计界面。

建议单独一节进行专门介绍，也可以写在第四章各功能模块的概要处理流程的介绍中，在描述各个功能模块的概要处理流程时加入节界面的设计，还允许所有的界面（包括用户图形界面、报表格式、菜单格式等）以附件的形式保存。

界面的设计，要求根据本软件所事先制订的有关界面约定或设计规范，初步画出各个用户的操作界面。

｝

第七章安全保密设计

｛为可选项，如果系统设计对安全保密性有特别的要求，则需要详细描述，主要可以从以下几方面进行考虑：

系统故障预防与恢复、用户管理和权限控制、数据备份和恢复等｝

7.1系统故障预防与恢复

｛为可选项，如果存在可能出现的系统故障需要恢复的情况，则要进行设计描述，主要说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法，建议可按照以下格式进行说明：

为恢复系统（包括软硬件）故障和人为因素引起的数据错，特设计以下措施：

出错现象

可能原因

措施

盘后清算出现异常

本地柜台的交易数据出错

恢复昨日盘后数据，重新接受交易所当日委托数据，重新进行清算

｝

7.2用户管理和权限控制

｛说明在数据库的设计中，将如何通过区分不同的访问者、不同的访问类型和不同的数据对象，进行分配权限并分别对待而获得的数据库安全保密的设计考虑。

｝

7.3数据备份与恢复

｛为可选项，如果存在数据备份与恢复的需求要求，则要做相应的设计描述。

对数据备份与恢复的设计，主要说明在适当的时间点上，如何设计系统的数据备份和数据恢复功能，以便在系统失效、出现意外及数据出错、或有充分的需要的时候，可以在可接受的时间内得以恢复到最近或以前某个时间点的数据备份上，要求描述清楚实现数据备份和恢复的整个设计思想以及实现方法。

｝

第八章系统运行设计

｛为可选项，当系统足够大被拆分成若干子系统，如果不专门介绍系统运行时各子系统之间的运行机制和控制关系，则开发人员无法理解本概要设计说明书而导致无法实现系统功能时，才有必要进行相关运行设计的描述。

运行设计，主要用来说明运行模块的组合，进行软件系统的构造设计，确定系统的运行控制方法及资源分配情况｝

8.1运行模块组合

｛说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件，建议画出系统运行机制结构图来表示，再附上简要的文字说明，以描述清楚各个运行模块（包括各种运行的进程），分别如何运行在各自指定的硬件上（必要时要说明相关的硬件配置及其在运行环境下所起的作用）｝

8.2运行控制

｛描述清楚各个运行模块进行运行控制的方式、方法和操作步骤，以及每种运行模块组合将各自占用的各种资源情况，以及对时间响应的要求，可以分别从以下几方面进行描述：

多机管理，一台服务器应允许多台客户端机器加入应用系统，则要描述清楚服务器是如何进行管理多台机器的。

合法性检查，当客户端需要访问后台数据库的业务数据时，有关应用系统的网关服务或其他相关服务程序是如何进行用户身份的合法性校验，一般系统都会要求每一个用户发出某个服务请求后，必须首先输入自己的用户名和密码

请求响应，有关服务器对用户的各种请求的响应，采用多线程的并发处理还是单线程的串行顺序处理等方式的实现情况，以及对事务处理的时间响应要求等

控制界面，关于用户监控系统（如：

国泰君安实时监控系统）的监控屏幕上应该显示各种业务处理信息，出现异常时要求要实时报警或做相应妥善的处理。

通讯控制，描述清楚系统所采纳的通讯平台的有关说明，包括前台和后台之间的通讯、网关之间的数据转换处理，以及通讯时所采用的通讯协议等内容

核心业务处理，说明对客户的许多关键或主要业务的系统实现，在整个运行机制中是如何进行控制的｝

第九章系统出错处理设计

｛为可选项，如果不专门对系统出错信息进行设计描述，将导致开发人员无法理解本概要设计的有关出错信息的处理说明，无法实现有关出错处理功能时，才需要描述本章节的内容｝

9.1出错处理信息

｛罗列本软件系统可能的出错或故障情况出现的各种出错处理信息，包括系统出错信息提示的形式（包括出错对话框的设计）、含义及处理方法等。

在操作出错或数据出错等情况下，系统显示或记录的有关出错代码／信息，要求要符合相关的《系统出错处理设计规范》（如果规范存在的话）｝

9.2出错处理对策

｛说明故障出现或系统出错后可能采取的变通补救办法，主要包括：

设置后备技术、性能降级（即降效技术）、恢复及再启动等等。

设置后备技术，体现在：

当原始系统数据万一丢失时则启用的副本的建立或启动的技术，采用磁带备份等

降效技术，也是一种后备技术，体现在：

使用另一种效率稍低的系统或方法求得所需结果的某些部分，如手工操作。

｝

第十章系统维护设计

｛为可选项，当本系统需要维护，并且系统足够复杂或规模足够大时如果不事先进行有关维护的设计，则该系统将来可能导致无法维护时，则需要说明为方便维护工作的设施，如设计专用的维护模块等。

系统维护的设计主要考虑安排用于系统的检查与维护的检查点和专用模块等方面，可以从数据维护和功能维护进行描述｝

10.1数据维护

｛系统在各业务模块提供数据核查功能，用以检查数据的一致性、连续性，并定位出错记录，支持系统的数据维护等｝

10.2功能维护

｛罗列功能模块的维护列表｝

第十一章版本设计

｛可选项，如果本软件系统作为公司研发中心的软件产品，并且可能会拥有比较　大的客户群体，而且会有根据本系统派生出来的个性化的半定制软件的升级需求，此时需要事先考虑有关软件产品升级班本的控制办法以及版本号的升级原则，具体的版本设计方法可建议参照公司有关ISO程序文件《产品标识与可追溯性控制程序》｝

附件

{罗列与本概要设计报告相关的文档资料，可包括以下内容：

1．数据库设计的有关文档资料

2．用户界面有关约定、相关报表或模板格式、各种常规底稿模板等

3．各种设计规范，可包括屏幕设计规范、程序设计规范、存储过程设计规范、出错处理设计规范等等

4．其它相关资料｝