mb0601软件概要设计说明模板结构化方法

mb0601mb0601软件概要设计说明模板结构化方法软件概要设计说明模板结构化方法 1 2系统概述标识并描述本文档使用的CSCI 可以是一个系统中的多 个配置项 在系统中的作用 运行环境等 包括系统和软件的一般特性 概述系统开发 运行和维护的历史 标识项目的投资方 需方 用户 开发方和支持机构 1 3文档概述本文档为软件概要设计说明的参考模板 本文档的各章节和提示为编制文档所必须的要素 文档开发人员可 根据项目的特点和需要调整本文档的结构和描述方式 但应保证本 文档要求的要素均能得到充分的描述 文档开发人员应根据项目需要 包括用户需要 组织需要和项目特 点 在本文档的基础上做适当的扩展以满足项目的要求 本文档模板涵盖了GJB438B xx GB T8567 xx和总装备部软件工程规范 xx版 对软件概要设计说明文档的要 素和内容的要求 本节描述概要设计说明的作用 目的 阅读对象 给出文档各章节 的主要内容和组织方式 1 4基线说明本文档依赖的分配基线及基线版本 2引用文件按文档号 标题 编写单位 和作者 和出版日期等 列 出本文档引用的所有文件 3术语和定义给出所有在本文档中出现的专用术语和缩略语的确切定 义 给出本文档中描述需求所使用的符号的含义 4总体说明本章描述影响产品和设计的一般引述 而不叙述具体设计 它提供设计的总体描述和背景 并使它们更易理解 本章内容无需作为设计项进行追踪 详细内容应在后续章节进行描 述 除下述章节外 设计文档中其余易受到关注的内容 如宇航产品的 可靠性设计等 宜在本章进行总体描述 4 1软件与系统的关系给出系统功能的描述 使用系统框图 数据流 图 部署图等各类示意图 描述系统的组成 软件在系统中的位置 及与系统中其他软件 硬件的关系 给出软件的运行环境 部署的软硬件环境和对外接口 并描述软 件与系统中各软件配置项和硬件配置项间的接口 XX软件XX分系统XX分系统XX分系统XX软件查询命令上级部门XX分系 统数据库访问XX分系统图图4 1软件与系统的关系图4 2软件功能描述本部分描述软件主要功能 给出功能设计上的特点 并针对功能的特点分析设计应采取的设计 方案和措施 4 3项目特点分析分析本项目的特点和在概要设计说明中描述的应对 措施 包括用户特点 功能设计特点 系统环境特点 任务要求特点 政 策法规要求等 4 4设计决策本部分给出软件设计决策的结论和过程 包括系统级和 需求中选定的设计要求 在概要设计时已确定或无法确定的设计决 策 对于未确定的设计决策 应给出决策的依赖 具备决策权的人员 决策需要的输入等 决策的例子包括a 算法选择的决策 b 软件模块选择的决策 包括 商业 开源和自研模块间的选择 c 软件行为的决策 d 安全性 保密性设计的决策 e 可靠性 安全性设计的决策 4 5软件业务流程 建立与设计模块的关系 本部分给出软件的业务 流程 本节与需求规格说明中的同名章节的主要区别在于 概要设 计中的软件业务流程明确了各个活动的执行模块 这些执行模块应 与设计中的模块 组件严格对应 4 6软硬件环境说明和需求一致 4 7复用说明给出使用的可复用模块以及复用的方式 表表4 1复用情况表序号号模块标识模块名称复用方式平台可复用底模块标 识平台可复用底模块名称平台可复用底模块版本1 CSC XXX 1XXX模块更改参数P CSC XXX 1XXX模块1 22 CSC XXX 2XXX模块新研 3 CSC XXX 3XXX模块更改P CSC XXX 3XXX模块1 24 CSC YYY 1XXX模块完全复用P CSC YYY 1XXX模块1 35 CSC YYY 1XXX模块完全复用P CSC YYY 2XXX模块1 1模块总数完全复用模块数更改配置参数模块数新增模块 数数更改模块数数新增 更动模块比例5XXX配置项概要设计5 1配置 项结构设计5 1 1总体数据流根据需求规格说明中的功能定义 对配 置项进行分解 形成若干个设计模块 计算机软件部件CSC 必要 时 对设计模块进行多层次的分解 形成设计子模块 并描述模块划分的思路和策略 本部分可使用系统结构框图 数据流图 描述模块的分解以及模块 之间的关系 注意 这里的数据流图与需求分析的数据流的描述角度不同 应为 设计模块与设计模块之间的数据流 本章节应起到承接需求与设计的作用 可结合需求跟踪表 描述设 计模块与需求的功能 子功能之间如何对应 这里应包含软件设计使用的第三方组件 程序等 XXX配置项在需求分析阶段已划分为XXX XXX等X个功能 在此基础 上 进行分解形成XX个设计模块 XX配置项数据流图见图5 1 XX模块数据流图图图5 1XXX配置项设计模块间数据流图图a 设备监控模块1 设备监控界面 子模块该组件具备XXX功能 满足XXX性能要求 其依赖于XXX组件完 成XX工作 XX组件调用本组件完成XX工作 是否关键模块是 2 XXX b 公共组件1 XXX5 1 2总体流程使用流程图描述设计模块间的动态 控制关系 包括异步处理 并发执行 进程 线程 中断创建和管理 等动态行为 在本节中 流程图的执行对象为 总体数据流 中分解出的设计模 块 这里仅需给出所有线程 进程 中断清单 并描述并行处理运行的 方式及其间的关系 并行处理的细节 在各模块的说明中详细描述 5 1 2 1XXX中断 进程 线程描述配置项各类中断处理 进程 线程 描述它们间存在通信关系 对于只允许创建一个进程的程序 也应在这里给出相应的说明 标识XXX中断 T01 概述实现的功能 相关模块给出中断响应模块给出发出中断的模块相关中断给出和本 中断存在交互 创建关系的终端异步交互给出中断间共享的资源和 通信的信号量 优先级1 5 1最低a 中断 进程 线程执行主流程使用流程图 描述 中断的执行过程 中断涉及到的设计模块 本中断与其他中断和主 进程间的关系 如信号量 共享缓冲区等 图图5 2XX中断流程图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读取监控数据接口标识读取监控数据SI 01接口概述流程数据管理从数据库读取监控数据 通信方式JDBC访问ORACLE数据库 组合方式数据库MONITORDATA表 发起方方流程数据管理组件接收方数据库优先级1 5 1最低实现模 块流程数据管理表表5 1XX接口参数表序号字段名数据类型长度单位范围 枚举精度约束1 2 5 3模块设计说明逐项描述5 1节的分解出的设计模块的设计 5 3 1XXX模块 标识XXX 5 3 1 1模块概况本部分应给出模块的总 体说明 包括组件实现的各项指标 功能概述 模块与其他模块的 关系 完整列出和本模块有接口的模块 本组件依赖的组件 并描 述依赖关系 必要时 针对本模块绘制数据流图 对于第三方模块 可复用模块库 作出情况说明后 可以仅描述需 要使用的开发接口和其他相关内容即可 标识XXX相关需求1 需求标识需求名称 2 MON1任务调度 3 XXX性 能指标要求1s内完成处理 分解到本组件的处理时间为0 5s 4 XXX 外部接口给出本组件实现的外部接口及标识 概述给出模块的功能和设计特点 采用的设计方法 设计思想和设 计模式等 父模块描述与其他模块间的从属关系 子模块描述与其他模块间的从属关系 依赖的模块XXX依赖模块的说明 依赖本模块的模块XXX调用本模块 获取业务流程执行过程中的数据 在界面展示 使用的外部数据使用的数据库表 数据文件等 设计约束给出本模块满足的设计约束实现对象模块对应的实体 如tsf dll 复用方式给出复用方式和 并应给出的版本等配置管理信息 复用方式为完全复用 修改配置参数级复用 代码级复用 5 3 1 2开发接口设计本节应给出模块外接口的设计 应包括且仅包 括所有使用本模块需要使用的接口定义 数据结构的说明 通常 本模块的使用者仅需阅读本节即可使用模块完成工作 本节设计应与5 2 2模块开发接口中与本组件模块的接口一一对应 模块实现的对外接口 配置项外 配置项内的文件系统 数据库 进程间调用等 的实现应在模块内部设计部分说明 a XXX接口文件 Interface h 本部分给出给出该接口的说明 说明应和该接口的注释一致 如本接口为数据获取接口 调用本接口可获取GPS数据 1 readGPSData函数对函数的说明 说明应和该方法的注释一致 下表为该方法的各个参数的描述 类型长度 可剪裁 参数名称描述int4字节dataType数据类型 0代 表XXX 1代表XXX int4字节dataSize数据大小 范围为0 9999999TaskData taskData任务数据结构 详细结构参见TaskData数据结构的设计 boolean1字节return返回值 任务启动结果 true为成功 false为失败 b TaskData数据结构下表给出数据结构的各个属性 类型型长度 可剪裁 参数名称描述String4字节startDate任务开 始日期 格式为yyyy MM dd String4字节stopDate任务结束日期 格式为yyyy MM dd c 公共变量本部分给出公共变量的设计 5 3 1 3界面设计给出本模块包含的界面设计 包括界面原型和界面 操作流程 人机工程设计 给出本模块界面应收集的数据列表及应显示的数据列表 不包含界面的模块可删除本部分 5 3 1 4内部设计本部分应给出本模块各函数间的关系 并给出函数 的控制流程 a 静态关系给出本模块实现的函数及其之间的关系 b 流程图给出本模块各函数的流程图 XXX函数流程图图图5 3XXX函数流程图图c 异常处理给出函数执行过程中可能出现的异常 和异常处理方式 可使用控制流图描述异常处理 异常处理包括参数校验 内存中对象数量的限制 线程数量的限制 通信异常 磁盘读写异常 与外部通信时遇到的异常等 5 3 1 5并行 并发处理设计本节专项描述本模块的线程安全设计 描述中断 线程之间的关系 给出接口的同步特性 a XXX中断并发处理设计需详细给出该中断需要访问的共享资源 以 及对共享的资源互斥访问机制 分析中断访问可能导致的数据一致性问题和乱序问题 确保对共享 资源的访问控制能够保证程序执行结果和预期一致 5 3 1 6资源管理设计a 内存资源管理对于界面 图片资源 大型数 组等必须考虑其占用的资源及保护措施 b 通信链路资源管理通信 链路连接池等 c 数据库链接资源管理数据库链接池等 d 磁盘文 件资源管理磁盘空间预警设计 磁盘文件写入互斥的保证措施等 5 3 1 7可扩展性设计a 可配置参数包括组件可配置的参数列表及说 明 配置文件格式和相对路径 数据库表及格式的设计 b 上下文 参数设计可使用实体类描述可定义的参数 c 预编译宏设计 注设计时应当尽可能的将可配置的变量集中存放 必要时可以较容 易的将这些参数变为配置文件 5 3 1 8其他非功能要求的设计给出本组件为满足性能 安全性 可 靠性 可测性 安全性 保密性等的考虑 以及应实现的功能 可以引用组件其他设计章节说明 5 4实现设计包括各组件与编译生成的二进制文件的对应关系 程序 的文件夹结构 配置文件的存放路径 日志文件的存放路径等 本列表中的文件应该在前文对应的章节有详细描述 表表5 2XX程序文件列表表文件名存放路径类别说明log dll bin lib三方组件日志管理tsf X X X dll bin lib新研组件业务流程调度组件 X X X为版本号 mon dll bin lib自研可复用组件通用工具包config xml config配置文件主程序的配置文件yyyyMMdd log log日志文件按日期命名的日志文件software dll bin新研组件主程序Software exe可执行程序主程序制作的可执行程 序5 5部署设计图图5 4XX部署图部署图应和需求文档指定的软硬件环境对应 应描述全部 需要部署的软件 执行的软件进程 硬件平台 6数据库设计给出软件需要访问数据库 描述各个数据库的用途 6 1概念数据库设计给出实体关系图 并描述数据库实体关系 USR ROLEUSR ROLELOG SATELLITESTATIONINFO FAULTDEVICE MONITOR CONTROLSTATUS MACHINE INFO STATUS MACHINE EXINFOMACRO CONFIG LEVEL CODEMACRO CONFIG LEVEL MACRO CONFIG DEVICEMACRO CONFIG MAND MACRO POINT VALUETRTASK TRACKTRCANCEL TRCANCELACKTRREPORT图图6 1数据库实体关系图图6 2逻辑数据库6 2 1数据库表清单表表6 1数据库库表清单序号表名说明1 2 3 6 2 2库表描述6 2 2 1XXX表 表表6 2XX表列名数据类型注释约束USR ID NUMBER 5 0 用户标识主键USR LOGONNAME VARCHAR2 50 登录名唯一6 3物理数据库设计针对系统的特点 给出数据库服 务器的部署方法 运行参数配置 7其他设计7 1配置项初始化数据设计给出配置项新安装时的初始化 数据要求 包括参数的初始化配置 需要建立的数据库表 数据库 表中应该有的记录等 7 2安装设计给出安装程序制作的技术方案 包括使用的打包工具 安装向导设计 exe制作工具等 8组装设计本章定义软件各组件的组装方法和顺序 根据各组件间的依赖关系以