密级:普通
<项目名称>
项目编号:XXXXX
概要设计说明书
All rights reserved
版权所有,侵权必究
文档修订记录
目 录
1 简介.... 5
1.1 目的... 5
1.2 范围... 5
1.3 定义、首字母缩写词和缩略语... 5
1.4 参考资料... 5
2 系统概述.... 5
2.1 系统目标... 5
2.2 设计原则... 5
2.3 运行环境... 5
2.3.1 硬件平台... 5
2.3.2 软件平台... 5
2.3.3 网络体系结构... 6
2.4 应用软件整体结构概述... 6
2.5 关键技术... 6
3 性能设计.... 6
3.1 性能目标... 6
3.2 系统性能问题分析... 7
3.3 系统性能保障措施... 7
4 层功能设计.... 7
4.1 层间关系图... 7
4.2 XXX层功能设计... 7
4.2.1 功能描述... 7
4.2.2 组件结构图... 7
4.2.3 组件描述... 8
4.2.4 组件间接口... 8
4.2.4.1 XXX接口... 8
4.2.5 提供给上层的接口... 8
4.2.5.1 XXX接口... 8
5 系统功能分解.... 9
5.1 系统功能分解结构... 9
5.2 XXX子系统... 9
5.2.1 模块关系图... 9
5.2.2 XXX模块... 9
5.2.2.1 功能描述... 9
1 简介
1.1 目的
[阐明此文档的编写目的。]
1.2 范围
[简要说明此文档描述的内容范围,比如:软件实现的功能或不实现的功能,软件的应用领域等。]
1.3 定义、首字母缩写词和缩略语
[本小节应提供正确理解此文档所需的全部术语的定义、首字母缩写词和缩略语。 这些信息可以通过引用项目词汇表来提供。]
1.4 参考资料
[本小节应完整列出此文档中所引用的任何文档。列出可从中获取这些参考资料的来源。这些信息可以通过引用附录或其他文档来提供。]
2 系统概述
2.1 系统目标
【说明】开发意图、应用目标(总目标、分期目标)、作用范围、预期效益等。
2.2 设计原则
【说明】设计原则应包括:
※ 质量管理应贯穿于整个设计之全过程。
※ 对质量保证的承诺应落实到全体人员。
※ 实际执行的过程中,必须符合项目自身的特点,体现个性差异,切实做到有的放矢。
2.3 运行环境
2.3.1 硬件平台
【说明】指出本系统对硬件设备的需求、我们选型的原则和依据、推荐的型号与配置、性能综述、技术优势、特殊约定等。
2.3.2 软件平台
【说明】使用操作系统的名称、生产厂家、版本号等。
使用数据库的名称、生产厂家、版本号等。如使用了多种数据库,则要说明如何
实现互连。
其它支撑软件:指出开发与运行时需要的工具软件的情况,如4GL等。
对于选用的各类软件,均应着重说清其技术特点、与国内外同类产品的比较,明
确阐述我方选择的理由。
2.3.3 网络体系结构
【说明】写明网络设计原则、技术要求、产品选型、拓扑结构、基本部件与配件、传输介质、接口情况、通信协议、约束条件、结构化综合布线方案等。
画出网络结构图。图中应标出各类服务器与客户机、网管机、路由器、网关等的数量与分布;应反映出局域网、广域网及其互连的情况;如使用国内的公用数据网或Internet,也须具体标出。
用文字说明各个服务器/客户机的作用、配置与具体位置。例如:Oracle数据库服务
器1台,位于局信息中心,用于支撑征管业务信息处理、领导决策辅助支持、各征管业务科室的信息采集、查询及统计工作。它安装在IBM RS6000小型机上,操作系统是AIX 3.2。
说明拟采取的网络保护技术,如防火墙等。
2.4 应用软件整体结构概述
【说明】说明本系统的各层模块、公用模块的划分原则。
如果系统复杂而开发者又有比较多的技术积累,应说明其分层构造(如组件层、构件层与应用子系统层)。
对于大的系统,应画出体系结构图并予以说明。
2.5 关键技术
【说明】本系统采用了哪些关键技术,如算法、中间件、构件等。
指出使用了那些主要工具。
解释作出上述选择的理由。
说明这些关键技术在整体结构中的位置及内外接口。
3 性能设计
3.1 性能目标
[本节描述系统的需要达到的性能目标,建议采用如下格式描述:]
根据用户需求,系统的性能目标如下:
以下指标要求的环境:
3.2 系统性能问题分析
[分析描述于系统性能有管的问题]
3.3 系统性能保障措施
[下面列出了软件的6组性能,共涵盖21个子特性。这些性能/子特性的相对重要性并不是等同的。编写时,可以基于具体项目的实际需求,对下述标题或内容进行取舍/侧重。与《软件需求规格说明书》不同,这里应着重说明:为使系统能够达到下述性能,准备采取哪些具体措施。参看《软件需求规格说明书》的相应章节。]
第一节 功能性
第二节 可靠性
第三节 易使用性
第四节 高效性
第五节 可维护性
第六节 可移植性
4 层功能设计
4.1 层间关系图
[参见:架构设计说明书--逻辑架构]
4.2 XXX层功能设计
4.2.1 功能描述
4.2.2 组件结构图
4.2.3 组件描述
【对于每个组件,采用如下格式描述:】
4.2.4 组件间接口
4.2.4.1 XXX接口
4.2.4.1.1 接口定义
【对于每个接口,采用如下格式描述:】
4.2.4.1.2 方法
【对于每个接口,采用如下格式描述:】
4.2.5 提供给上层的接口
4.2.5.1 XXX接口
4.2.5.1.1 接口定义
【对于每个接口,采用如下格式描述:】
4.2.5.1.2 方法
【对于每个接口,采用如下格式描述:】
5 系统功能分解
5.1 系统功能分解结构
[这一节简要说明软件系统的功能分解结构(比如:系统-子系统-模块), 分解到模块]
【对每个子系统重复使用下面的格式】
5.2 XXX子系统
5.2.1 模块关系图
5.2.2 XXX模块
5.2.2.1 功能描述
第二篇:05软件项目国标文档模板-概要设计说明书
1引言... 2
1.1编写目的... 2
1.2背景... 2
1.3定义... 2
1.4参考资料... 2
2总体设计... 2
2.1需求规定... 2
2.2运行环境... 2
2.3基本设计概念和处理流程... 3
2.4结构... 3
2.5功能器求与程序的关系... 3
2.6人工处理过程... 3
2.7尚未问决的问题... 3
3接口设计... 3
3.1用户接口... 3
3.2外部接口... 3
3.3内部接口... 4
4运行设计... 4
4.1运行模块组合... 4
4.2运行控制... 4
4.3运行时间... 4
5系统数据结构设计... 4
5.1逻辑结构设计要点... 4
5.2物理结构设计要点... 4
5.3数据结构与程序的关系... 4
6系统出错处理设计... 5
6.1出错信息... 5
6.2补救措施... 5
6.3系统维护设计... 5
概要设计说明书
1引言
1.1编写目的
说明编写这份概要设计说明书的目的,指出预期的读者。
1.2背景
说明:
a. a. 待开发软件系统的名称;
b. b. 列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站(中心)。
1.3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资料
列出有关的参考文件,如:
a. a. 本项目的经核准的计划任务书或合同,上级机关的批文;
b. b. 属于本项目的其他已发表文件;
c. 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. a. 后备技术说明准备采用的后备技术,当原始系统数据万一丢失时启用的副本的建立和启动的技术,例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术;
b. b. 降效技术说明准备采用的后备技术,使用另一个效率稍低的系统或方法来求得所需结果的某些部分,例如一个自动系统的降效技术可以是手工操作和数据的人工记录;
c. c. 恢复及再启动技术说明将使用的恢复再启动技术,使软件从故障点恢复执行或使软件从头开始重新运行的方法。
6.3系统维护设计
说明为了系统维护的方便而在程序内部设计中作出的安排,包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。 各个程序之间的对应关系,可采用如下的矩阵图的形式;