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

1、代代 号号 名名 称称 XXX 软件概要设计说明软件概要设计说明 单单 位位 航天恒星 编编 写写 校校 对对 审审 核核 标标 审审 批批 准准 航天恒星科技有限公司航天恒星科技有限公司 编 号 密 级 阶 段 页 数21 会会 签签 文档控制文档控制 变更记录变更记录 版本号版本号日期日期作者作者 段落、图段落、图 或表或表 增加增加/修修 改改/删除删除 简单描述简单描述更改申请单号更改申请单号 郝胜勇创建文档编写 2.0.0贺然修改 1.02009-01-08郝胜勇创建文档编写 2.0.0贺然修改 2.1.0贺然修改增加、细化填写 指导内容；对标 GJB5000A、GJB4 38B、总

2、装备部软 件工程规范 2.1.1贺然修改修改校对错误 2.2.0贺然修改按A4系统要求修 改封面 3.00.00贺然修改在4.7节增加平台 覆盖率统计表格 目目 录录 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配置项

3、结构设计 .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

4、 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 程序文

5、件列表程序文件列表 .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 系统概述系统概述 标识并描述本文

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

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

8、应在后续章节进行描述。 除下述章节外，设计文档中其余易受到关注的内容（如宇航产品的可靠性 设计等）宜在本章进行总体描述。 4.1 软件与系统的关系软件与系统的关系 给出系统功能的描述，使用系统框图、数据流图、部署图等各类示意图， 描述系统的组成，软件在系统中的位置及与系统中其他软件、硬件的关系。给 出软件的运行环境（部署的软硬件环境和对外接口） ，并描述软件与系统中各软 件配置项和硬件配置项间的接口。 X XX X软软件件 X XX X分分系系统统 X XX X 分分系系统统 X XX X分分系系统统 X XX X软软件件 查查询询命命令令 上上级级部部门门 X XX X分分系系统统 数数据据

9、库库访访问问 X XX X 分分系系统统 图图 4-1 软件与系统的关系图软件与系统的关系图 4.2 软件功能描述软件功能描述 本部分描述软件主要功能，给出功能设计上的特点，并针对功能的特点分 析设计应采取的设计方案和措施。 4.3 项目特点分析项目特点分析 分析本项目的特点和在概要设计说明中描述的应对措施。包括用户特点、 功能设计特点、系统环境特点、任务要求特点、政策法规要求等。 4.4 设计决策设计决策 本部分给出软件设计决策的结论和过程，包括系统级和需求中选定的设计 要求、在概要设计时已确定或无法确定的设计决策。对于未确定的设计决策， 应给出决策的依赖（具备决策权的人员、决策需要的输入等

10、） 。决策的例子包括： a.算法选择的决策； b.软件模块选择的决策（包括商业、开源和自研模块间的选择） ； c.软件行为的决策； d.安全性、保密性设计的决策； e.可靠性、安全性设计的决策。 4.5 软件业务软件业务流程（流程（建立建立与设计模块的关系）与设计模块的关系） 本部分给出软件的业务流程，本节与需求规格说明中的同名章节的主要区 别在于，概要设计中的软件业务流程明确了各个活动的执行模块，这些执行模 块应与设计中的模块/组件严格对应。 4.6 软硬件环境说明软硬件环境说明 和需求一致。 4.7 复用说明复用说明 给出使用的可复用模块以及复用的方式。 表表 4-1 复用情况表复用情况表

11、 序序 号号 模块标识模块标识模块名称模块名称复用方式复用方式 平台可复用平台可复用 底底模块模块标识标识 平台可复用平台可复用 底底模块模块名称名称 平台可复用平台可复用 底底模块模块版本版本 1.CSC-XXX-1XXX 模块更改参数P-CSC-XXX-1XXX 模块1.2 2.CSC-XXX-2XXX 模块新研 3.CSC-XXX-3XXX 模块更改P-CSC-XXX-3XXX 模块1.2 4.CSC-YYY-1XXX 模块完全复用P-CSC-YYY-1XXX 模块1.3 5.CSC-YYY-1XXX 模块完全复用P-CSC-YYY-2XXX 模块1.1 模块总数模块总数 完全复用模块数

12、完全复用模块数 更改配置参数模块数更改配置参数模块数 新增模块新增模块数数 更更改改模块模块数数 新增、更动模块比例新增、更动模块比例 5XXX 配置项配置项概要概要设计设计 5.1 配置项配置项结构结构设计设计 5.1.1总体数据流总体数据流 根据需求规格说明中的功能定义，对配置项进行分解，形成若干个设计模 块（计算机软件部件 CSC） ，必要时，对设计模块进行多层次的分解，形成设 计子模块。并描述模块划分的思路和策略。 本部分可使用系统结构框图、数据流图，描述模块的分解以及模块之间的 关系。注意，这里的数据流图与需求分析的数据流的描述角度不同，应为设计 模块与设计模块之间的数据流。 本章节

13、应起到承接需求与设计的作用，可结合需求跟踪表，描述设计模块 与需求的功能/子功能之间如何对应。 这里应包含软件设计使用的第三方组件、程序等。 XXX 配置项在需求分析阶段已划分为 XXX、XXX 等 X 个功能，在此基础 上，进行分解形成 XX 个设计模块。XX 配置项数据流图见 Error! Reference source not found.。 XX 模块数据流图 图图 5-1 XXX 配置项设计模块间数据流图配置项设计模块间数据流图 a.设备监控模块 1)设备监控界面子模块 该组件具备 XXX 功能，满足 XXX 性能要求，其依赖于 XXX 组件完成 XX 工作，XX 组件调用本组件完

14、成 XX 工作； 是否关键模块：是。 2)XXX b.公共组件 1)XXX 5.1.2总体流程总体流程 使用流程图描述设计模块间的动态控制关系，包括异步处理、并发执行、 进程/线程/中断创建和管理等动态行为。在本节中，流程图的执行对象为“总体 数据流”中分解出的设计模块。 这里仅需给出所有线程、进程、中断清单，并描述并行处理运行的方式及 其间的关系。并行处理的细节，在各模块的说明中详细描述。 5.1.2.1 XXX 中断中断/进程进程/线程线程 描述配置项各类中断处理/进程/线程，描述它们间存在通信关系。对于只允 许创建一个进程的程序，也应在这里给出相应的说明。 标识标识XXX 中断（T01）

15、 概述概述实现的功能。 相关模块相关模块给出中断响应模块 给出发出中断的模块 相关中断相关中断给出和本中断存在交互、创建关系的终端 异步交互异步交互给出中断间共享的资源和通信的信号量。 优先级优先级15，1 最低 a.中断/进程/线程执行主流程 使用流程图，描述中断的执行过程、中断涉及到的设计模块、本中断与其 他中断和主进程间的关系（如信号量、共享缓冲区等） 。 图图 5-2 XX 中断流程图中断流程图 b.中断/进程/线程执行异常流程 给出本中断执行异常时的处理流程。描述方式类同主流程。 5.1.3性能的分配性能的分配 在本节给出对性能指标的分析和分解。性能指标的分解应落实到模块。 5.2

16、接口设计接口设计 给出配置项对外接口，及各个组件之间的接口的设计。包括接口的标识、 同步异步特性、接口的形式、数据格式等进行详细的说明。接口关系图可参见 Error! Reference source not found.给出的数据流图。 5.2.1配置项外部接口配置项外部接口 外部接口若在接口文档或需求中有详细说明，直接引用接口文档或需求即 可。Error! Reference source not found.给出的外部实体可采用特殊的颜色标识。 以区分软件内部模块；图中的消息名称应与外部接口一致。如 Error! Reference source not found.中与设备通信的接口为

17、外部接口。 5.2.2模块开发接口模块开发接口 本节可给出配置项中，各模块的开发接口，本节可以给出各开发接口的简 单描述，详细内容在各模块的“模块开发接口设计”部分详细说明。 模块开发接口包括软件实现的中断响应接口、软件模块函数调用接口、共 享内存区域等。 5.2.3模块其他接口模块其他接口 模块其他接口包括模块间的进程通信接口（本地过程调用、远程过程调用） 、 文件访问接口、数据库访问接口、网路通信接口等。要求： 进程通信接口通常有接口描述语言描述接口，应在接口描述中给出详细描 述； 文件访问结构应给出文件的样例； 数据库访问接口可参见“数据库设计”部分； 网络通信接口应给出底层的数据帧格式

18、。 5.2.3.1 读取监控数据读取监控数据 接口标识接口标识读取监控数据 SI-01 接口概述接口概述流程数据管理从数据库读取监控数据。 通信方式通信方式JDBC 访问 ORACLE 数据库。 组合方式组合方式数据库 MONITORDATA 表。 发起方发起方流程数据管理组件 接收方接收方数据库 优先级优先级15，1 最低 实现模块实现模块流程数据管理 表表 5-1 XX 接口参数表接口参数表 序号序号字段名字段名数据类型数据类型长度长度单位单位范围范围/枚举枚举精度精度约束约束 1. 2. 5.3 模块设计说明模块设计说明 逐项描述 Error! Reference source not

19、found.节的分解出的设计模块的设计。 5.3.1XXX 模块（标识：模块（标识：XXX） 5.3.1.1 模块概况模块概况 本部分应给出模块的总体说明，包括组件实现的各项指标、功能概述、模 块与其他模块的关系（完整列出和本模块有接口的模块、本组件依赖的组件， 并描述依赖关系，必要时，针对本模块绘制数据流图） 。 对于第三方模块、可复用模块库，作出情况说明后，可以仅描述需要使用 的开发接口和其他相关内容即可。 标识标识XXX 相关需求相关需求1.需求标识：需求名称； 2.MON1 任务调度； 3.XXX 性能指标：要求 1s 内完成处理，分解到本组件的处理时间 为 0.5s； 4.XXX 外

20、部接口：给出本组件实现的外部接口及标识。 概述概述给出模块的功能和设计特点，采用的设计方法、设计思想和设计模 式等。 父模块父模块描述与其他模块间的从属关系。 子模块子模块描述与其他模块间的从属关系。 依赖的模块依赖的模块XXX：依赖模块的说明。 依赖本模块的模块依赖本模块的模块XXX：调用本模块，获取业务流程执行过程中的数据，在界面展示。 使用的外部数据使用的外部数据使用的数据库表、数据文件等。 设计约束设计约束给出本模块满足的设计约束 实现对象实现对象模块对应的实体。如 tsf.dll。 复用方式复用方式给出复用方式和来源，并应给出来源的版本等配置管理信息。 复用方式为：完全复用、修改配置

21、参数级复用、代码级复用。 5.3.1.2 开发开发接口设计接口设计 本节应给出模块外接口的设计，应包括且仅包括所有使用本模块需要使用 的接口定义、数据结构的说明。通常，本模块的使用者仅需阅读本节即可使用 模块完成工作。本节设计应与 Error! Reference source not found.Error! Reference source not found.中与本组件模块的接口一一对应。 模块实现的对外接口（配置项外、配置项内的文件系统、数据库、进程间 调用等）的实现应在模块内部设计部分说明。 a.XXX 接口文件（Interface.h） 本部分给出给出该接口的说明。说明应和该接口的

22、注释一致。如： 本接口为数据获取接口，调用本接口可获取 GPS 数据。 1)readGPSData 函数 对函数的说明。说明应和该方法的注释一致。 下表为该方法的各个参数的描述。 类型类型长度（可剪裁）长度（可剪裁）参数参数名称名称描述描述 int4 字节dataType数据类型，0 代表 XXX，1 代表 XXX int4 字节dataSize数据大小，范围为 0 TaskDatataskData任务数据结构。详细结构参见 TaskData 数据 结构的设计。 boolean1 字节return返回值，任务启动结果。true 为成功，false 为失败。 b.TaskData 数据结构 下表

23、给出数据结构的各个属性。 类型类型长度（可剪裁）长度（可剪裁）参数参数名称名称描述描述 String4 字节startDate任务开始日期，格式为 yyyy-MM-dd String4 字节stopDate任务结束日期，格式为 yyyy-MM-dd c.公共变量 本部分给出公共变量的设计。 5.3.1.3 界面设计界面设计 给出本模块包含的界面设计，包括界面原型和界面操作流程。人机工程设 计。 给出本模块界面应收集的数据列表及应显示的数据列表。 不包含界面的模块可删除本部分。 5.3.1.4 内部内部设计设计 本部分应给出本模块各函数间的关系，并给出函数的控制流程。 a.静态关系 给出本模块实

24、现的函数及其之间的关系。 b.流程图 给出本模块各函数的流程图。 XXX 函数流程图 图图 5-3 XXX 函数流程图函数流程图 c.异常处理 给出函数执行过程中可能出现的异常和异常处理方式。可使用控制流图描 述异常处理。异常处理包括参数校验、内存中对象数量的限制、线程数量的限 制、通信异常、磁盘读写异常、与外部通信时遇到的异常等。 5.3.1.5 并行并行/并发处理设计并发处理设计 本节专项描述本模块的线程安全设计。描述中断、线程之间的关系，给出 接口的同步特性。 a.XXX 中断并发处理设计 需详细给出该中断需要访问的共享资源，以及对共享的资源互斥访问机 制。分析中断访问可能导致的数据一致

25、性问题和乱序问题，确保对共享资源 的访问控制能够保证程序执行结果和预期一致。 5.3.1.6 资源管理设计资源管理设计 a.内存资源管理：对于界面、图片资源、大型数组等必须考虑其占用的 资源及保护措施； b.通信链路资源管理：通信链路连接池等； c.数据库链接资源管理：数据库链接池等； d.磁盘文件资源管理：磁盘空间预警设计、磁盘文件写入互斥的保证措 施等。 5.3.1.7 可扩展性设计可扩展性设计 a.可配置参数：包括组件可配置的参数列表及说明、配置文件格式和相 对路径、数据库表及格式的设计； b.上下文参数设计：可使用实体类描述可定义的参数； c.预编译宏设计。 注：设计时应当尽可能的将可

26、配置的变量集中存放，必要时可以较容易的 将这些参数变为配置文件。 5.3.1.8 其他非功能要求的设计其他非功能要求的设计 给出本组件为满足性能、安全性、可靠性、可测性、安全性、保密性等的 考虑，以及应实现的功能。可以引用组件其他设计章节说明。 5.4 实现设计实现设计 包括各组件与编译生成的二进制文件的对应关系、程序的文件夹结构，配 置文件的存放路径，日志文件的存放路径等。 本列表中的文件应该在前文对应的章节有详细描述。 表表 5-2 XX 程序文件列程序文件列表表 文件名文件名存放路径存放路径类别类别说明说明 log.dllbin/lib三方组件日志管理 tsf.X.X.X.dllbin/

27、lib 新研组件业务流程调度组件。 X.X.X 为版本号。 common.dllbin/lib自研可复用组件通用工具包 config.xmlconfig 配置文件主程序的配置文件 yyyyMMdd.loglog日志文件按日期命名的日志文件 software.dllbin新研组件主程序 Software.exe可执行程序主程序制作的可执行程序 5.5 部署设计部署设计 件件件件件件件件件件 executionEnvironment Windows Server 2003 executionEnvironment JDK 件件件件 NPort件件 device GSM Modem 1111 图图

28、5-4 XX 部署图部署图 部署图应和需求文档指定的软硬件环境对应，应描述全部需要部署的软件、 执行的软件进程、硬件平台。 6数据库设计数据库设计 给出软件需要访问数据库，描述各个数据库的用途。 6.1 概念数据库设计概念数据库设计 给出实体关系图，并描述数据库实体关系。 USRROLE USR_ROLE LOGSATELLITESTATIONINFOFAULT DEVICE_MONITOR _CONTROL STATUS_MACHINE_INFOSTATUS_MACHINE_EXINFO MACRO_CONFIGLEVEL_CODE MACRO_CONFIG_LEVELMACRO_CONFI

29、G_DEVICE MACRO_CONFIG_COMMANDMACRO_POINT_VALUE TRTASKTRACKTRCANCELTRCANCELACKTRREPORT 图图 6-1 数据库实体关系数据库实体关系图图 6.2 逻辑数据库逻辑数据库 6.2.1数据库表清单数据库表清单 表表 6-1 数据库库表清单数据库库表清单 序号序号 表名表名 说明说明 1. 2. 3. 6.2.2库表描述库表描述 6.2.2.1 XXX 表表 表表 6-2 XX 表表 列名列名数据类型数据类型注释注释约束约束 USR_IDNUMBER5,0用户标识主键 USR_LOGONNAMEVARCHAR2(50)登录名唯一 6.3 物理数据库设计物理数据库设计 针对系统的特点，给出数据库服务器的部署方法，运行参数配置。 7其他设计其他设计 7.1 配置项初始化数据设计配置项初始化数据设计 给出配置项新安装时的初始化数据要求，包括参数的初始化配置、需要建 立的数据库表、数据库表中应该有的记录等。 7.2 安装设计安装设计 给出