概要设计说明书.docx

概要设计说明书.docx

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

概要设计说明书

亿阳信通****项目****软件

概要设计说明书

亿阳信通文档编号：

CRI_O_PEVPD_Template_HLD_V1.0

发布日期：

2002/08

部门：

撰写：

文档状态：

正式版V1.0

版权属于亿阳信通所有，无亿阳信通的书面同意，任何个人或组织无权拷贝。

文档修改记录

版本号

主要作者

修改记录

完成日期

目录

1范围1-1

1.1标识1-1

1.2系统概述1-1

1.3文档概述1-1

2引用文档2-2

3设计方法和原则3-3

3.1限制和约束3-3

3.2设计遵循原则3-3

3.3设计方法3-3

4总体设计4-4

4.1系统性能目标4-4

4.2软件系统概述4-4

4.3模块划分4-4

4.3.1模块1名称、标识4-4

4.3.2模块2名称、标识4-4

4.4模块调用关系4-4

4.5模块依赖性4-5

4.6人工处理4-5

5接口设计5-6

5.1用户接口5-6

5.2外部接口5-6

5.2.1接口1名称、标识5-7

5.2.2接口2名称、标识5-7

5.3内部接口5-7

6出错和维护设计6-8

6.1出错处理6-8

6.1.1出错信息6-8

6.1.2补救措施6-8

6.2维护设计6-8

7安全和测试考虑7-9

7.1安全保密7-9

7.2测试要点7-9

附录1模块版本描述7-10

附录2需求覆盖说明7-11

1范围

1.1标识

⏹缩略语，包括本文档规定的名词术语以及英文缩写：

序号

缩略语

说明/定义

英文全称

中文译名

⏹本文档适用的集成系统和软件系统是：

⏹文档存放路径：

1.2系统概述

描述本文档所适用的集成系统和软件系统的一般特征。

简要说明项目背景、规模等。

说明：

如果本概要设计为软件系统总体的概要设计，则给出本节信息；如果是模块概要设计，则不再说明此信息。

1.3文档概述

简述本文档的内容和目的。

本文档是软件详细设计和编码的重要依据。

本文将描述：

2引用文档

本文档中直接引用的所有文档，包括其它相关文档、经审批的立项申请表或合同、批文和编制该文档时参考的资料、文献、技术标准等。

编号

文档名称

作者/修订者

发布日期

出版单位

备注

软件需求说明书

3设计方法和原则

描述现有开发条件和需实现的目标，说明概要设计应遵循的原则和采用的设计方法。

3.1限制和约束

简要说明现有技术条件、资金状况、开发环境（工具和平台）、时间限制以及在上述条件下要实现的系统目标。

3.2设计遵循原则

描述对本软件系统进行概要设计的原则。

注，设计原则可考虑以下内容：

⏹命名规则，意义明确无二义、简洁、无重复，如果是改进系统，则命名规则应考虑与原系统的一致性。

⏹模块独立性原则，避免重复定义，处理完整，输入输出明确；

⏹边界设计原则，包括外部接口、内部接口和用户接口，如有“接口设计”文档，在此引用即可；

⏹数据库或数据文件的设计规则，如有“数据库设计”文档，在此引用即可；

⏹安全和保密原则；

⏹系统的灵活性、适用性及可维护性；

⏹等。

3.3设计方法

基于以上考虑，说明采用的设计方法。

如果其中某些设计依赖于某种运行状态或方式，则在此说明这种特定依赖条件和必要的设计约定。

4总体设计

根据“软件需求说明书”中功能需求的划分进行软件结构的概要设计。

4.1系统性能目标

a）确定目标系统运行平台

b）确定目标系统开发环境、开发工具、开发方法

c）确定目标系统的系统软件、支持软件、主要运行设备的型号和性能要求

d）确定目标系统的移植范围和安全性

4.2软件系统概述

给出系统总体的结构图。

简要说明本软件系统在系统总体中的作用、接收的输入和产生的输出，以及与其它系统的相互关系。

4.3模块划分

根据需求分析阶段功能的分类，确定本软件系统的内部结构和组成元素。

注意：

总体结构设计一般采取自顶向下的办法，逐级分解软件需求。

对于大型系统，可按主要功能将其分解为若干子系统，然后为每个子系统定义功能模块、确定各模块之间的相互关系。

划分功能模块，用图表示。

以下各节将分别对每个模块进行描述。

4.3.1模块1名称、标识

说明模块1的功能和性能要求和必要的设计约束。

描述模块1的数据流和控制流，给出与其子模块之间的关系。

4.3.2模块2名称、标识

同上。

4.4模块调用关系

使用USECASE工具，描述在不同系统状态和操作模式下，运行软件时模块之间的调用关系。

标明控制顺序、控制流和数据流走向，以及系统状态的转变。

4.5模块依赖性

如果本设计是对现有系统的改造过程，说明新的设计会对原有的哪些模块造成影响，并给出原有模块的开发状态信息（可引用相关文档）。

如：

序号

新模块标识

是否原有模块改造

原有模块标识

受影响模块

处理措施

4.6人工处理

系统工作流程中，如有必需的人工干预和处理过程，在此进行描述，给出手工处理界面。

5接口设计

描述本软件系统的接口特性。

如果另行编写“接口设计文档”，则此处引用。

接口的类型分为三种：

用户接口、外部接口和内部接口。

从不同接口对象出发，对接口特性的要求就有不同。

接口特性主要指以下方面：

⏹接口对象的优先权

⏹接口的执行类型

如实时数据传输、数据的存储和检索等。

⏹接口对象的数据特性

如输出、存储、传输、访问、接收等。

⏹通过接口的数据元素/集合（记录、消息、文件、报告等）描述

名称、唯一标识、数据类型、长度和格式、值域、精度、约束、来源和目的；数据集合的结构、介质、输出的视觉和听觉特性、集合间的关系等。

⏹接口的通讯方式

链接、介质以及它们的性能；传输的消息格式；控制流，如序列号或缓存分配；数据传输速率、周期性/不定期、两次传输间隔；路由、地址和命名约定；优先权和级别；安全、保密考虑，如加密算法、用户验证、权限和审核。

⏹接口使用的协议

协议的优先级和层；打包，包括拆分、重组、路由和寻址；合法校验、错误控制和恢复程序；同步，包括建立连接、维持和终止；状态、标识和其它输出特性。

⏹其它特性

如接口对象的物理兼容性，如尺寸、公差、负载、电压、插口的兼容性等等。

5.1用户接口

描述本软件系统应建立的与用户的接口，即人机接口：

⏹列出提供给用户的操作命令以及每条命令的语法结构，如果是图形用户接口，给出操作界面；

⏹列出用户提交不同命令时，本软件系统做出的应答信息。

5.2外部接口

描述本软件系统与系统总体中其它部分的接口，包括：

⏹与硬件的接口；

⏹与其它软件系统的接口；

⏹与相关支持软件，如非开发软件的接口，并对支持软件加以说明。

5.2.1接口1名称、标识

给出接口1与其接口对象关系图，并说明该接口的特性。

描述接口对象，指出哪些接口对象是固有不变的、哪些将开发或修改。

如果接口对象不是固有不变的，以假设方式描述，如“当假设接口对象做什么时，相关接口对象将……”。

此处也可引用相关文档说明。

5.2.2接口2名称、标识

……

5.3内部接口

描述本软件系统各功能模块之间的接口。

同5.2节。

6出错和维护设计

6.1出错处理

6.1.1出错信息

列出发生每种出错和故障情况时，系统输出的错误信息形式、含义以及处理方法。

6.1.2补救措施

说明出现故障后，可能采取的变通措施。

包括：

⏹后备技术

原始系统数据时，副本的建立和启动技术，如周期性的数据备份等。

⏹降效技术

采用其它效率稍低的系统或方法来求得所需结果的某些部分，如自动系统的手工操作和数据的人工记录。

⏹恢复及重启技术

使软件从故障点恢复执行或使软件从头开始重新运行的方法。

6.2维护设计

建立系统适宜、方便的维护设计，如设置系统自检的检查点和专用模块的设计。

7安全和测试考虑

7.1安全保密

7.2测试要点

给出测试模块的主要测试要求。

附录1模块版本描述

说明每一模块的名称、标识、版本号

模块名称

标识

可运行版本

依赖模块及版本

附录2需求覆盖说明

开发软件需求阶段

概要设计阶段

分类

软件需求项编号

版本

负责人

模块编号

负责人