MB06-03 软件详细设计说明模板(结构化方法

代号名称XXX软件详细设计说明单位航天恒星编写校对审核标审批准航天恒星科技有限公司编号密级阶段页数11会签文档控制变更记录版本号日期作者段落、图或表增加/修改/删除简单描述更改申请单号1.02009-01-08郝胜勇创建文档编写2.0.020110525贺然修改2.1.020110921贺然修改增加、细化填写指导内容；对标GJB5000A、GJB438B、总装备部软件工程规范2.1.120120516贺然修改修改校对错误3.00.0020131028贺然修改按A4系统要求修改封面I目录1范围..........................................................................................................................11.1标识...................................................................................................................................11.2系统概述...........................................................................................................................11.3文档概述...........................................................................................................................11.4基线...................................................................................................................................12引用文件..................................................................................................................13术语和定义..............................................................................................................24总体说明..................................................................................................................24.1软件与系统的关系...........................................................................................................24.2软件功能描述...................................................................................................................34.3项目特点分析...................................................................................................................34.4设计决策...........................................................................................................................34.5软硬件环境说明...............................................................................................................35XXX配置项详细设计.............................................................................................35.1模块名称...........................................................................................................................35.1.1计算机软件单元名称...............................................................................................46其他设计..................................................................................................................67追踪关系..................................................................................................................6II图目录图4-1软件与系统的关系图.........................................................................................3III表目录表5-1XX接口参数表..................................................................................................4表5-2函数参数表........................................................................................................5表7-1概要设计跟踪表.................................................................................................6表7-2概要设计反向跟踪表.........................................................................................611范围1.1标识写明本文档的：a.本文档的标识号：R/产品代号/区分号/XS-01；b.标题：XXXX软件详细设计说明；c.本文档适用于XXX系统/软件/XXXXCSCI。1.2系统概述标识并描述本文档使用的CSCI（可以是一个系统中的多个配置项）在系统中的作用、运行环境等。包括系统和软件的一般特性；概述系统开发、运行和维护的历史；标识项目的投资方、需方、用户、开发方和支持机构。1.3文档概述本文档为软件详细设计说明的参考模板。本文档的各章节和提示为编制文档所必须的要素，文档开发人员可根据项目的特点和需要调整本文档的结构和描述方式，但应保证本文档要求的要素均能得到充分的描述。文档开发人员应根据项目需要（包括用户需要、组织需要和项目特点）在本文档的基础上做适当的扩展以满足项目的要求。本文档模板涵盖了GJB438B-2009、GB/T8567-2006和总装备部软件工程规范（2008版）对软件详细设计说明文档的要素和内容的要求。本节描述详细设计说明的作用、目的、阅读对象，给出文档各章节的主要内容和组织方式。1.4基线说明本文档依赖的分配基线及基线版本。2引用文件按文档号、标题、编写单位（和作者）和出版日期等，列出本文档引用的所2有文件。3术语和定义给出所有在本文档中出现的专用术语和缩略语的确切定义。给出本文档中描述需求所使用的符号的含义。4总体说明本章描述影响产品和设计的一般引述，而不叙述具体设计。它提供设计的总体描述和背景，并使它们更易理解。本章内容无需作为设计项进行追踪，详细内容应在后续章节进行描述。除下述章节外，设计文档中其余易受到关注的内容（如宇航产品的可靠性设计等）宜在本章进行总体描述。4.1软件与系统的关系给出系统功能的描述，使用系统框图、数据流图、部署图等各类示意图，描述系统的组成，软件在系统中的位置及与系统中其他软件、硬件的关系。给出软件的运行环境（部署的软硬件环境和对外接口），并描述软件与系统中各软件配置项和硬件配置项间的接口。XX软件XX分系统XX分系统XX分系统XX软件查询命令上级部门XX分系统数据库访问XX分系统3图4-1软件与系统的关系图4.2软件功能描述本部分描述软件主要功能，给出功能设计上的特点，并针对功能的特点分析设计应采取的设计方案和措施。4.3项目特点分析分析本项目的特点和在概要设计说明中描述的应对措施。包括用户特点、功能设计特点、系统环境特点、任务要求特点、政策法规要求等。4.4设计决策本部分给出软件设计决策的结论和过程，包括系统级和需求中选定的设计要求、在概要设计时已确定或无法确定的设计决策。对于未确定的设计决策，应给出决策的依赖（具备决策权的人员、决策需要的输入等）。决策的例子包括：a.算法选择的决策；b.软件模块选择的决策（包括商业、开源和自研模块间的选择）；c.软件行为的决策；d.安全性、保密性设计的决策；e.可靠性、安全性设计的决策。4.5软硬件环境说明和需求一致。5XXX配置项详细设计5.1模块名称对于直接使用的第三方模块，只需描述其功能、接口和其它必要的特征，可根据需要裁减下列章节。从5.1.1开始，分节标识和描述模块中的各个计算机软件单元（如函数、结4构等）。可在本部分利用计算机软件单元间的控制流图和数据流图描述计算机软件单元间的关系。5.1.1计算机软件单元名称以下各小节是对一个软件单元全集进行说明，设计具体的类时可根据情况适当裁减。计算机软件单元可以是函数、结构、公共变量集等。5.1.1.1计算机软件单元简述本部分描述该单元的基本特征，包括但不限于以下信息：功能概述设计思路设计约束需求5.1.1.2输入/输出本部分给出软件单元的输入输出接口。包括函数的形参、访问的公共变量、处理的中断和信号量、访问的外部接口等。a.外部接口1)XXX接口接口标识读取监控数据SI-01接口概述流程数据管理从数据库读取监控数据。通信方式JDBC访问ORACLE数据库。组合方式数据库MONITORDATA表。发起方流程数据管理组件接收方数据库优先级1~5，1最低实现模块流程数据管理表5-1XX接口参数表序号字段名数据类型长度单位范围/枚举精度约束1.2.b.函数的形参5表5-2函数参数表类型长度（可剪裁）参数名称描述int4字节dataType数据类型，0代表XXX，1代表XXXint4字节dataSize数据大小，范围为0~9999999TaskDatataskData任务数据结构。详细结构参见TaskData数据结构的设计。boolean1字节return返回值，任务启动结果。true为成功，false为失败。c.访问的公共变量给出软件单元需要访问的公共变量，及使用方法。d.处理的中断和信号量给出软件单元需发起和处理的中断和信号量。5.1.1.3局