概要设计说明书.

《概要设计说明书.》由会员分享，可在线阅读，更多相关《概要设计说明书.（22页珍藏版）》请在金锄头文库上搜索。

1、XXX系统VerX.X概要设计说明书 共22页 第22页密 级：秘 密系统名称：XXXX系统系统版本：X.X文档分类：系统设计文件编号：XXXX系统Ver X.X概要设计说明书XXX计算机有限公司XXXX年X月目 录目 录21.引言31.1文档目的31.2项目概述31.3参考资料31.4术语定义31.5修改记录32.系统概述32.1系统实现目标32.2条件与限制32.3运行环境33.需求概述33.1.总体描述33.2.系统角色33.3.系统功能33.3.4.功能划分33.3.5.用例清单33.4.性能和运行需求34.总体设计34.1设计原则34.2设计规范34.3软件体系结构35.模块结构设计

2、35.1组件模块总体设计35.1.1.组件模块的划分和功能描述35.1.2.组件模块关系35.1.3.组件模块的物理分布35.1.4.组件模块与用例映射35.2组件模块描述35.2.1.组件模块136.用例实现37.数据结构设计38.接口设计39.系统安全设计39.1系统故障预防和恢复39.2用户管理和权限控制39.3数据备份与恢复39.3.1.数据备份39.3.2.数据恢复310.系统运行设计310.1运行模块组合310.2运行控制311.系统出错处理设计311.1出错处理信息311.1.1.通讯线路错误311.1.2.系统环境错误311.1.3.应用设计错误311.2出错处理对策312.系

3、统维护设计312.1数据维护312.2功能维护313.系统版本设计314.附件31. 引言1.1 文档目的简要说明编写这份概要设计说明书的目的，指出预期的读者。本概要设计说明书的编写目的是为了说明系统总体设计的技术方案，从程序系统的设计考虑，包括系统的基本处理流程、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等内容，以向整个设计期提供关于程序系统的逻辑和数据功能实现方式的总体描述，从而作为程序详细设计或编码的基础。设计阶段将以本文档为核心文档。本概要设计说明书的适用读者为：软件开发者、测试人员。1.2 项目概述1.说明待开发的软件系统的名称2.列出本项目的任务委托单位、开

4、发单位、协作单位、用户单位3.说明项目背景，叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。如果本次开发的软件系统是一个更大的系统的一个组成部分，则要说明该更大系统的组成和介绍本系统与其它相关系统的关系和接口部分4.保密说明：本项为可选项，一般的软件公司都会要求对软件开发的概要设计文档进行保密，不允许被复制、使用和扩散到公司之外的范围，如果需要强调则允许做相关的保密说明5.版权说明：本项为可选项，若有必要，才要作有关的描述。1.3 参考资料列出编写本报告时参考的文件(如经核准的计划任务书或合同、上级机关的批文等)、资料、技术标准，以及他们的作者、标题、

5、编号、发布日期和出版单位。这些文件主要包括：n 本软件开发所经核准的合同或标书或可行性报告等文档n 软件开发计划书n 需求分析报告n 测试方案（若存在初稿的话）n 与本项目有关的已发表的文件或资料n 本文件中各处引用的文件、资料，所采用的软件开发标准和规范编号资料名称简介作者日期出版单位列出编写本报告时查阅的Intenet上杂志、专业著作、技术标准以及他们的网址。网 站简 介1.4 术语定义列出本文档中所引用到的专门术语的定义和首字母缩写词、缩略语的原文，以便对概要设计说明书进行适当的解释1.5 修改记录编号修改内容描述修改人审核人批准人修改日期备注2. 系统概述概要地介绍本软件系统，只要求提

6、供影响设计的一般因素，不必太详细地描述大量细节，本章主要目的仅仅是使本设计说明书更加易于理解，建议根据系统设计的实际需要可以有选择地从以下方面进行概要描述：系统实现目标、条件与限制、运行环境、需求概述2.1 系统实现目标说明完成本项目要达到的目标，可从以下几方面考虑设计：n 人力与设备费用的节省；n 处理速度的提高；n 控制精度或生产能力的提高；n 管理信息服务的改进；n 决策系统的改进；n 人员工作效率的提高；n 安全可靠性的保证；2.2 条件与限制为可选项，只要当软件系统的设计或开发受到某种特定的限制，或者可直接能影响系统设计的某种因素，这些因素可能成为系统的设计约束，他们的改变可能会影响

7、某些需求的实现时，才需要做概要介绍。若存在以下方面的系统约束或条件限制时，可以进行相关的阐明：（但不限于这些）1. 为完成本软件系统应具备的特定条件、开发单位已具备的条件以及尚需创造的条件,如：现阶段还未到位的设备、资源等需要做出相应的约束说明2. 必要时，还应说明用户及分合同承包者承担的工作、完成期限及其他条件与限制，如果用户及分合同承包者对系统的实现起到的某些作用会直接影响系统设计的成败则要特别说明3.本系统的设计规范需要受到某些特定的行业规范的限制4.本系统的开发需要受到用户对系统的工程化管理的某些特别的要求，包括用户规定对系统实现的全过程的变更规定5.本系统设计工作所需的一些假定条件和

8、必须满足的约束，如本功能的开发假定用户会熟练使用SQL语言，本功能的实现应该在某功能实现前开发完成等6.本系统的设计可能需要使用的所有购入构件、所有适用的许可或使用限制，以及所有相关的兼容性及互操作性或接口标准的有关限制和规定2.3 运行环境概要地说明本软件系统的运行环境的拓朴结构和布局，分别说明前、后台及网关或中间件的运行环境, 应包括通讯条件、网络环境、硬件配置、软件系统等其中硬件环境：要求列出为运行本软件所要求的硬件最小配置：n 处理器的型号、内存容量n 所要求的硬盘空间、分区格式、相关的记录格式、设备的型号和数量、联机/脱机等n I/O设备（联机/脱机）n 网络相关设备（型号、数量）支

9、持软件：说明为运行本软件所需要的支持软件，如：n 操作系统名称、对应的版本号、相关的Service Packagen 编译器和对应的版本号n 数据库管理系统和对应版本号n 其他支持软件这里只要求概要的说明一下，以便帮助理解本概要设计说明书，可参考以下格式：【前台】 计算机：IBM PC兼容机。操作系统：Microsoft Windows95/97/98/2000/NT操作系统数据库系统：IBM DB2数据库系统（客户端）应用软件：XXXXXXXX（客户端）网络：Ethernet,TCP/IP【后台】 计算机：IBM RS/6000操作系统：IBM AIX操作系统数据库系统：IBM DB2数据库

10、系统（服务端）应用软件：XXXXXXXX（服务端）网络：Ethernet,TCP/IP3. 需求概述根据系统设计的实际需要，简要介绍系统的需求情况，不必详细描述需求的具体细节，只仅仅要求能够更好帮助理解本设计说明书的内容，建议有选择地从功能需求、性能需求和运行需求进行分别描述，对于直接影响系统设计的关键或主要功能、性能以及运行要求等方面进行概要介绍，如果性能和运行需求方面对设计影响不大，则允许不必说明3.1. 总体描述对系统的整体需求进行概述3.2. 系统角色描述系统的用户，权限等Actor缩写名称描述 英语简称 3.3. 系统功能3.3.4. 功能划分对系统进行功能划分3.3.5. 用例清单

11、根据划分，列出各个功能模块功能ID功能名称系统角色使用权限描 述列出所有系统角色，并用表示具有相应权限3.4. 性能和运行需求4. 总体设计4.1 设计原则介绍本系统的结构设计原则和总体设计指导思想，主要从系统设计实现的目标来考虑，比如：处理速度、安全保密性、可扩展性等方面进行阐述，可以使用一些套话稍做修改即可。建议参考以下范例进行描述：n 数据实时性强监控的实时性是不言而喻的。无论实时检测还是动态显示交易汇总数据和盘中异常结果，都要求实时监控的算法尽量优化，处理简洁，这样才能真正达到实时监控的目的，为总部进行盘中稽核和及时处理异常情况提供有效的手段。n 可扩充性强由于交易业务是不断扩展的，监

12、控的指标及功能都是不断扩大或变化的，故系统必须具有良好的可扩充性。系统设计应尽可能结构化、模块化，并与其他子系统预留相应的接口。n 可维护性好由于证券市场、政策及其管理是随着整个国民经济的发展而变化的，要求对交易业务的实时监控具有相当的灵活性，以便于维护。n 先进性系统采用国际流行的J2EE开放式框架，主要软硬件设备符合国际标准，集成了国际水平的主流生产厂的先进产品，应用软件采用B/S结构。n 数据完整性、安全性高财务系统数据的完整性和安全性是非常重要的。一个安全的客户/服务器系统应该是客户端机器的任何操作都通过服务器来实现其一致性和完整性控制。数据库及财务稽核系统本身都应提供分级授权、日志记

13、录等手段来确保系统的安全。4.2 设计规范说明可以引用公司现有的各种设计规范或各种软件开发的国家标准或规范，主要包括：（不限于以下几种，也不指定）n 命名约定 规定系统和子系统名, 程序名, 数据库表(文件)名, 数据名, 变量名等的编制规范。n 界面约定规定屏幕界面的总体布局，如菜单行、显示主体、图标按钮、提示信息、出错信息等规范化，统一风格。n 程序编写规范根据采用的编程工具特点，制定规范化要求，使程序易读易懂，可维护，可移植。具体选用的规范，只要对设计有所帮助就可以罗列，编号及相关规范标题可以自行决定。对于引用公司事先制订的有关规范或现存的各种国家标准等规范，则可以简单地描述，并参见XX

14、XXXXXX规范或标准，文件可以作为本概要设计说明书的附件进行保存如果一个系统比较大需要拆分成若干个子系统，而每个子系统需要各自编制概要设计文档，则只需要在一个总的概要设计说明书进行描述，其他子系统允许不专门进行描述，或注明参见XXXXXXX概要设计说明书。4.3 软件体系结构简要介绍系统的总体结构和概要功能，可以通过画系统设计总体框架结构图的方式，再附上简单的文字说明,对本软件系统的总体功能进行概要描述。对于采用J2EE平台的系统，参考如下：系统的体系架构是一个系统的骨架，其重要性对一个系统的建设能否成功至关重要。建立一个合适的体系架构关系到系统的业务需求；关系到系统的运行模式；关系到系统的性能需求，如安全性、可扩展性等。