软件概要设计报告模板

《软件概要设计报告模板》由会员分享，可在线阅读，更多相关《软件概要设计报告模板（21页珍藏版）》请在金锄头文库上搜索。

1、编VIU 密rLr*t版XX系统工程XX软件概要设计报告（结构化方法）编写校对审核批准国家测绘局卫星测绘应用中心XX公司201X年XX月文档控制变更记录目录1范围 11.1标识 11.2系统概述 11.3文档概述 11.4基线 12引用文件 13术语和定义 24总体说明 24.1软件与系统的关系 24.2软件功能描述 34.3项目特点分析 34.4设计决策 34.5软件业务流程（建立与设计模块的关系） 34.6软硬件环境说明 34.7复用说明 35XXX 配置项概要设计 45.1配置项结构设计 45.1.1总体数据流 45.1.2总体控制流 45.1.3性能的分配 55.2接口设计 55.2.

2、1配置项外部接口 55.2.2模块开发接口 65.2.3模块其他接口 65.3.1 XXX 模块（标识：XXX） 75.4 实现设计 105.5 部署设计 106数据库设计 116.1概念数据库设计 116.2逻辑数据库116.2.1 数据库表清单116.2.2库表描述116.3物理数据库设计 127其他设计 127.1 配置项初始化数据设计 127.2 安装设计 128组装设计 128.1第一轮组装 128.1.1第一组 128.1.2 第 X 组138.1.3 组装完成后的产品部件 138.2 第X轮组装139 追踪关系 13图目录图 4-1 软件与系统的关系图3图 5-1 XXX 配置项

3、设计模块间数据流图 4图 5-4 XX 中断控制流图 5图 5-8 XXX 函数控制流图 9图 5-9 XX 部署图 10图 6-1 数据库实体关系图 11表目录表 5-1 XX 接口参数表 6表 5-2 XX 程序文件列表 10表 6-1 数据库库表清单 11表 6-2 XX 表 11表 9-1 接口控制文件跟踪表 13表 9-2 需求规格说明跟踪表 131 范围1.1 标识写明本文档的：a. 本文档的标识号：R/产品代号/区分号/GS-01；b. 标题： XXXX 软件概要设计说明；c. 本文档适用于XXX系统/软件/XXXXCSCI。1.2 系统概述标识并描述本文档使用的CSCI （可以

4、是一个系统中的多个配置项）在系统 中的作用、运行环境等。包括系统和软件的一般特性；概述系统开发、运行和 维护的历史；标识项目的投资方、需方、用户、开发方和支持机构。1.3 文档概述本文档为软件概要设计说明的参考模板。本文档的各章节和提示为编制文 档所必须的要素，文档开发人员可根据项目的特点和需要调整本文档的结构和 描述方式，但应保证本文档要求的要素均能得到充分的描述。文档开发人员应 根据项目需要（包括用户需要、组织需要和项目特点）在本文档的基础上做适当 的扩展以满足项目的要求。本文档模板涵盖了 GJB 438B-2009、GB/T 8567-2006和总装备部软件工程规 范（2008 版）对软

5、件概要设计说明文档的要素和内容的要求。本节描述概要设计说明的作用、目的、阅读对象，给出文档各章节的主要 内容和组织方式。1.4 基线说明本文档依赖的分配基线及基线版本。2 引用文件按文档号、标题、编写单位（和作者）和出版日期等，列出本文档引用的所有文件。3 术语和定义给出所有在本文档中出现的专用术语和缩略语的确切定义给出本文档中描述需求所使用的符号的含义。4 总体说明本章描述影响产品和设计的一般引述，而不叙述具体设计。它提供设计的 总体描述和背景，并使它们更易理解。本章内容无需作为设计项进行追踪，详 细内容应在后续章节进行描述。除下述章节外，设计文档中其余易受到关注的内容（如宇航产品的可靠性设

6、 计等）宜在本章进行总体描述。4.1 软件与系统的关系给出系统功能的描述，使用系统框图、数据流图、部署图等各类示意图，描 述系统的组成，软件在系统中的位置及与系统中其他软件、硬件的关系。给出软件的运行环境（部署的软硬件环境和对外接口），并描述软件与系统中各软件配置项和硬件配置项间的接口。图 4-1 软件与系统的关系图4.2 软件功能描述本部分描述软件主要功能，给出功能设计上的特点，并针对功能的特点分析 设计应采取的设计方案和措施。4.3 项目特点分析分析本项目的特点和在概要设计说明中描述的应对措施。包括用户特点、 功能设计特点、系统环境特点、任务要求特点、政策法规要求等。4.4 设计决策本部分

7、分条给出本文档中给出软件中的设计决策结论和过程，包括系统级 和需求中选定的设计要求、在概要设计时已确定或无法确定的设计决策。对于 未确定的设计决策，应给出决策的依赖（具备决策权的人员、决策需要的输入 等）。决策的例子包括：a. 算法选择的决策；b. 软件模块选择的决策（包括商业、开源和自研模块间的选择）；c. 软件行为的决策；d. 安全性、保密性设计的决策；e. 可靠性、安全性设计的决策。4.5 软件业务流程（建立与设计模块的关系）本部分给出软件的主要业务流程，本节与需求规格说明中的同名章节的需要 区别在于，概要设计中的软件业务流程明确了各个活动的执行模块，这些执行模 块为设计模块，与设计中的

8、模块/组件严格对应。4.6 软硬件环境说明和需求一致。4.7 复用说明给出使用的第三方库、可复用组件以及复用的方式。5 XXX 配置项概要设计5.1 配置项结构设计5.1.1 总体数据流根据需求规格说明中的功能定义，对配置项进行分解，形成若干个设计模块 (计算机软件部件CSC),必要时，对设计模块进行多层次的分解，形成设计子 模块。并描述模块划分的思路和策略。本部分可使用系统结构框图、数据流图，描述模块的分解以及模块之间的关 系。注意，这里的数据流图与需求分析的数据流的描述角度不同，应为设计模块 与设计模块之间的数据流。本章节应起到承接需求与设计的作用，可结合需求跟踪表，描述设计模块与 需求的

9、功能/子功能之间如何对应。这里应包含软件设计使用的第三方组件、程序等。XXX 配置项在需求分析阶段已划分为 XXX、XXX 等 X 个功能，在此基础 上，进行分解形成XX个设计模块。XX配置项数据流图见图5-1。XX 模块数据流图图 5-1 XXX 配置项设计模块间数据流图a. 设备监控模块1) 设备监控界面子模块该组件具备 XXX 功能，满足 XXX 性能要求，其依赖于 XXX 组件完成XX 工作， XX 组件调用本组件完成 XX 工作； 是否关键模块：是。2) XXXb. 公共组件1) XXX5.1.2 总体流程使用流程图描述设计模块间的动态控制关系，包括异步处理、并发执行、进 程/线程/

10、中断创建和管理的等动态行为。在本节中，流程图的执行对象为“总体 数据流”中分解出的设计模块。这里仅需给出所有线程、进程、中断清单，并描述并行处理运行的方式及其 间的关系。并行处理的细节，在各模块的说明中详细描述。5.1.2.1 XXX 中断/进程/线程描述配置项各类中断处理/进程/线程，描述它们间存在通信关系。对于只允许创建一个进程的程序，也应在这里给出相应的说明。标识XXX 中断（T01）概述实现的功能。相关模块给出中断响应模块 给出发出中断的模块相关中断给出和本中断存在父互、创建关系的终端异步交互给出中断间共享的资源和通信的信号量。优先级15, 1最低a. 中断/进程/线程执行主流程使用流

11、程图，描述中断的执行过程、中断涉及到的设计模块、本中断与其他 中断和主进程间的关系（如信号量、共享缓冲区等）。图 5-2 XX 中断流程图a. 中断/进程/线程执行异常流程 给出本中断执行异常时的处理流程。描述方式类同主流程。5.1.3 性能的分配在本节给出对性能指标的分析和分解。性能指标的分解应落实到模块。5.2 接口设计给出配置项对外接口，及各个组件之间的接口的设计。包括接口的标识、同 步异步特性、接口的形式、数据格式等进行详细的说明。接口关系图可参见 5.1.1 给出的数据流图。5.2.1 配置项外部接口外部接口若在接口文档或需求中有详细说明，直接引用接口文档或需求即 可。图 4-1 给

12、出的外部实体可采用特殊的颜色标识。以区分软件内部模块；图中的消息名称应与外部接口一致。如图 4-1 中与设备通信的接口为外部接口。5.2.2 模块开发接口本节可给出配置项中，各模块的开发接口，本节可以给出各开发接口的简单 描述，详细内容在各模块的“模块开发接口设计”部分详细说明。模块开发接口包括软件实现的中断响应接口、软件模块函数调用接口、共享 内存区域等。5.2.3 模块其他接口模块其他接口包括模块间的进程通信接口（本地过程调用、远程过程调用）、 文件访问接口、数据库访问接口、网路通信接口等。要求：进程通信接口通常有接口描述语言描述接口，应在接口描述中给出详细描 述；文件访问结构应给出文件的

13、样例； 数据库访问接口可参见“数据库设计”部分； 网络通信接口应给出底层的数据帧格式。5.2.3.1 读取监控数据接口标识读取监控数据SI-01接口概述流程数据管理从数据库读取监控数据。通信方式JDBC访问ORACLE数据库。组合方式数据库MONITORDATA表。发起方流程数据管理组件接收方数据库优先级15，1最低实现模块流程数据管理表 5-1 XX 接口参数表序号字段名数据类型长度单位范围/枚举精度约束1.2.5.3 模块设计说明逐项描述 5.1 节的分解出的设计模块的设计。5.3.1 XXX 模块（标识：XXX）5.3.1.1 模块概况本部分应给出模块的总体说明，包括组件实现的各项指标、

14、功能概述、模块 与其他模块的关系（完整列出和本模块有接口的模块、本组件依赖的组件，并描 述依赖关系，必要时，针对本模块绘制数据流图）。对于第三方模块、可复用模块库，作出情况说明后，可以仅描述需要使用的 开发接口和其他相关内容即可。标识XXX相关需求1. 需求标识：需求名称；2. M0N1任务调度；3. XXX性能指标：要求1s内完成处理，分解到本组件的处理时间 为 0.5s；4. XXX外部接口：给出本组件实现的外部接口及标识。概述给出模块的功能和设计特点，采用的设计方法、设计思想和设计模式 等。父模块描述与其他模块间的从属关系。子模块描述与其他模块间的从属关系。依赖的模块XXX :依赖模块的说明。依赖本模块的模块XXX :调用本模块，获取业务流程执行过程中的数据，在界面展示。使用的外部数据使用的数据库表、数据文件等。设计约束给出本模块满足的设计约束实现对象模块对应的实体。如tsf.dll。复用方式给出复用方式和来源，并应给出来源的版本等配置管理信息。 复用方式为：完全复用、修改配置参数级复