MB06-01 软件概要设计说明模板(结构化方法

文档控制变更记录目录1范围 (1)1.1标识 (1)1.2系统概述 (1)1.3文档概述 (1)1.4基线 (1)2引用文件 (1)3术语和定义 (2)4总体说明 (2)4.1软件与系统的关系 (2)4.2软件功能描述 (3)4.3项目特点分析 (3)4.4设计决策 (3)4.5软件业务流程（建立与设计模块的关系） (3)4.6软硬件环境说明 (3)4.7复用说明 (3)5XXX配置项概要设计 (4)5.1配置项结构设计 (4)5.1.1总体数据流 (4)5.1.2总体流程 (5)5.1.3性能的分配 (6)5.2接口设计 (6)5.2.1配置项外部接口 (6)5.2.2模块开发接口 (6)5.2.3模块其他接口 (6)5.3模块设计说明 (7)5.3.1XXX模块（标识：XXX） (7)5.4实现设计 (10)5.5部署设计 (11)6数据库设计 (11)6.1概念数据库设计 (11)6.2逻辑数据库 (12)6.2.1数据库表清单 (12)6.2.2库表描述 (12)6.3物理数据库设计 (12)7其他设计 (13)7.1配置项初始化数据设计 (13)7.2安装设计 (13)8组装设计 (13)8.1第一轮组装 (13)8.1.1第一组 (13)8.1.2第X组 (14)8.1.3组装完成后的产品部件 (14)8.2第X轮组装 (14)9追踪关系 (14)图4-1软件与系统的关系图 (3)图5-1 XXX配置项设计模块间数据流图 (5)图5-2 XX中断流程图 (6)图5-3 XXX函数流程图 (9)图5-4 XX部署图 (11)图6-1 数据库实体关系图 (12)表5-1 XX接口参数表 (7)表5-2 XX程序文件列表 (10)表6-1数据库库表清单 (12)表6-2 XX表 (12)表9-1接口控制文件跟踪表 (14)表9-2需求规格说明跟踪表 (14)表9-3接口控制文件反向跟踪表 (14)表9-4需求规格说明反向跟踪表 (15)1范围1.1标识写明本文档的：a.本文档的标识号：R/产品代号/区分号/GS-01；b.标题：XXXX软件概要设计说明；c.本文档适用于XXX系统/软件/XXXXCSCI。

1.2系统概述标识并描述本文档使用的CSCI（可以是一个系统中的多个配置项）在系统中的作用、运行环境等。

包括系统和软件的一般特性；概述系统开发、运行和维护的历史；标识项目的投资方、需方、用户、开发方和支持机构。

1.3文档概述本文档为软件概要设计说明的参考模板。

本文档的各章节和提示为编制文档所必须的要素，文档开发人员可根据项目的特点和需要调整本文档的结构和描述方式，但应保证本文档要求的要素均能得到充分的描述。

文档开发人员应根据项目需要（包括用户需要、组织需要和项目特点）在本文档的基础上做适当的扩展以满足项目的要求。

本文档模板涵盖了GJB 438B-2009、GB/T 8567-2006和总装备部软件工程规范（2008版）对软件概要设计说明文档的要素和内容的要求。

本节描述概要设计说明的作用、目的、阅读对象，给出文档各章节的主要内容和组织方式。

1.4基线说明本文档依赖的分配基线及基线版本。

2引用文件按文档号、标题、编写单位（和作者）和出版日期等，列出本文档引用的所有文件。

3术语和定义给出所有在本文档中出现的专用术语和缩略语的确切定义。

给出本文档中描述需求所使用的符号的含义。

4总体说明本章描述影响产品和设计的一般引述，而不叙述具体设计。

它提供设计的总体描述和背景，并使它们更易理解。

本章内容无需作为设计项进行追踪，详细内容应在后续章节进行描述。

除下述章节外，设计文档中其余易受到关注的内容（如宇航产品的可靠性设计等）宜在本章进行总体描述。

4.1软件与系统的关系给出系统功能的描述，使用系统框图、数据流图、部署图等各类示意图，描述系统的组成，软件在系统中的位置及与系统中其他软件、硬件的关系。

给出软件的运行环境（部署的软硬件环境和对外接口），并描述软件与系统中各软件配置项和硬件配置项间的接口。

图4-1软件与系统的关系图4.2软件功能描述本部分描述软件主要功能，给出功能设计上的特点，并针对功能的特点分析设计应采取的设计方案和措施。

4.3项目特点分析分析本项目的特点和在概要设计说明中描述的应对措施。

包括用户特点、功能设计特点、系统环境特点、任务要求特点、政策法规要求等。

4.4设计决策本部分给出软件设计决策的结论和过程，包括系统级和需求中选定的设计要求、在概要设计时已确定或无法确定的设计决策。

对于未确定的设计决策，应给出决策的依赖（具备决策权的人员、决策需要的输入等）。

决策的例子包括：a.算法选择的决策；b.软件模块选择的决策（包括商业、开源和自研模块间的选择）；c.软件行为的决策；d.安全性、保密性设计的决策；e.可靠性、安全性设计的决策。

4.5软件业务流程（建立与设计模块的关系）本部分给出软件的业务流程，本节与需求规格说明中的同名章节的主要区别在于，概要设计中的软件业务流程明确了各个活动的执行模块，这些执行模块应与设计中的模块/组件严格对应。

4.6软硬件环境说明和需求一致。

4.7复用说明给出使用的可复用模块以及复用的方式。

表4-1 复用情况表5XXX配置项概要设计5.1配置项结构设计5.1.1总体数据流根据需求规格说明中的功能定义，对配置项进行分解，形成若干个设计模块（计算机软件部件CSC），必要时，对设计模块进行多层次的分解，形成设计子模块。

并描述模块划分的思路和策略。

本部分可使用系统结构框图、数据流图，描述模块的分解以及模块之间的关系。

注意，这里的数据流图与需求分析的数据流的描述角度不同，应为设计模块与设计模块之间的数据流。

本章节应起到承接需求与设计的作用，可结合需求跟踪表，描述设计模块与需求的功能/子功能之间如何对应。

这里应包含软件设计使用的第三方组件、程序等。

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总体流程使用流程图描述设计模块间的动态控制关系，包括异步处理、并发执行、进程/线程/中断创建和管理等动态行为。

在本节中，流程图的执行对象为“总体数据流”中分解出的设计模块。

这里仅需给出所有线程、进程、中断清单，并描述并行处理运行的方式及其间的关系。

并行处理的细节，在各模块的说明中详细描述。

5.1.2.1XXX中断/进程/线程描述配置项各类中断处理/进程/线程，描述它们间存在通信关系。

对于只允许创建一个进程的程序，也应在这里给出相应的说明。

a.中断/进程/线程执行主流程使用流程图，描述中断的执行过程、中断涉及到的设计模块、本中断与其他中断和主进程间的关系（如信号量、共享缓冲区等）。

图5-2 XX中断流程图b.中断/进程/线程执行异常流程给出本中断执行异常时的处理流程。

描述方式类同主流程。

5.1.3性能的分配在本节给出对性能指标的分析和分解。

性能指标的分解应落实到模块。

5.2接口设计给出配置项对外接口，及各个组件之间的接口的设计。

包括接口的标识、同步异步特性、接口的形式、数据格式等进行详细的说明。

接口关系图可参见5.1.1给出的数据流图。

5.2.1配置项外部接口外部接口若在接口文档或需求中有详细说明，直接引用接口文档或需求即可。

图4-1给出的外部实体可采用特殊的颜色标识。

以区分软件内部模块；图中的消息名称应与外部接口一致。

如图4-1中与设备通信的接口为外部接口。

5.2.2模块开发接口本节可给出配置项中，各模块的开发接口，本节可以给出各开发接口的简单描述，详细内容在各模块的“模块开发接口设计”部分详细说明。

模块开发接口包括软件实现的中断响应接口、软件模块函数调用接口、共享内存区域等。

5.2.3模块其他接口模块其他接口包括模块间的进程通信接口（本地过程调用、远程过程调用）、文件访问接口、数据库访问接口、网路通信接口等。

要求：进程通信接口通常有接口描述语言描述接口，应在接口描述中给出详细描述；文件访问结构应给出文件的样例；数据库访问接口可参见“数据库设计”部分；网络通信接口应给出底层的数据帧格式。

5.2.3.1读取监控数据表5-1 XX接口参数表5.3模块设计说明逐项描述5.1节的分解出的设计模块的设计。

5.3.1XXX模块（标识：XXX）5.3.1.1模块概况本部分应给出模块的总体说明，包括组件实现的各项指标、功能概述、模块与其他模块的关系（完整列出和本模块有接口的模块、本组件依赖的组件，并描述依赖关系，必要时，针对本模块绘制数据流图）。

对于第三方模块、可复用模块库，作出情况说明后，可以仅描述需要使用的开发接口和其他相关内容即可。

5.3.1.2开发接口设计本节应给出模块外接口的设计，应包括且仅包括所有使用本模块需要使用的接口定义、数据结构的说明。

通常，本模块的使用者仅需阅读本节即可使用模块完成工作。

本节设计应与5.2.2模块开发接口中与本组件模块的接口一一对应。

模块实现的对外接口（配置项外、配置项内的文件系统、数据库、进程间调用等）的实现应在模块内部设计部分说明。

a.XXX接口文件（Interface.h）本部分给出给出该接口的说明。

说明应和该接口的注释一致。

如：本接口为数据获取接口，调用本接口可获取GPS数据。

1)readGPSData函数对函数的说明。

说明应和该方法的注释一致。

下表为该方法的各个参数的描述。

b.TaskData数据结构下表给出数据结构的各个属性。

c.公共变量本部分给出公共变量的设计。

5.3.1.3界面设计给出本模块包含的界面设计，包括界面原型和界面操作流程。

人机工程设计。

给出本模块界面应收集的数据列表及应显示的数据列表。

不包含界面的模块可删除本部分。

5.3.1.4内部设计本部分应给出本模块各函数间的关系，并给出函数的控制流程。

a.静态关系给出本模块实现的函数及其之间的关系。

b.流程图给出本模块各函数的流程图。

XXX函数流程图图5-3 XXX函数流程图c.异常处理给出函数执行过程中可能出现的异常和异常处理方式。

可使用控制流图描述异常处理。

异常处理包括参数校验、内存中对象数量的限制、线程数量的限制、通信异常、磁盘读写异常、与外部通信时遇到的异常等。

5.3.1.5并行/并发处理设计本节专项描述本模块的线程安全设计。

描述中断、线程之间的关系，给出接口的同步特性。

a.XXX中断并发处理设计需详细给出该中断需要访问的共享资源，以及对共享的资源互斥访问机制。