软件设计说明编写指南(438B)

密级：（软件项目名称）软件设计说明标识：版本：页数：拟制：SQA审核：审核：批准：拟制部门：年月日中国人民解放军XXXXXXXXXX研究所ii修改文档历史记录：日期版本说明修改人i目录1范围...............................................................................................................................................11.1标识....................................................................................................................................11.2系统概述............................................................................................................................11.3文档概述............................................................................................................................12引用文档.......................................................................................................................................13CSCI级设计决策..........................................................................................................................14CSCI体系结构设计......................................................................................................................24.1CSCI部件...........................................................................................................................24.1.1CSCI结构.............................................................................................................34.1.2CSC描述..............................................................................................................34.1.2.1CSC名称和项目唯一标识号...........................................................................34.1.3系统状态和模式.....................................................................................................44.2执行方案............................................................................................................................44.2.1CSC数据流与控制流图.........................................................................................54.2.2系统状态与模式的数据流与控制流.....................................................................54.3接口设计............................................................................................................................64.3.1接口设计准则.........................................................................................................64.3.2接口标识和接口图.................................................................................................64.3.X（接口的项目唯一的标识符）.............................................................................75CSCI详细设计............................................................................................................................105.X（软件单元的项目唯一的标识符，或者一组软件单元的标志符）...........................106需求可追踪性.............................................................................................................................127注释.............................................................................................................................................1211范围1.1标识【本条应描述本文档所适用的系统和软件的完整标识，适用时，包括其标识号、名称、缩略名、版本号及发布号。】1.2系统概述【本条应概述本文档所适用的系统和软件的用途。它还应描述系统与软件的一般特性；概述系统开发、运行和维护的历史；标识项目的需方、用户、开发方和保障机构等；标识当前和计划的运行现场；列出其它有关文档。】1.3文档概述【本条应概述本文档的用途和内容，并描述与它的使用有关的保密性方面的要求。】例：本文档描述XXXX系统软件的概要设计和详细设计，其内容和格式遵循GJB438B-2009的要求。本文档可作为设计评审的基础，编码的依据，软件测试的基准。2引用文档【本章应列出引用文档的编号、标题、编写单位、修订版本及日期。还应标识不能通过正常采购活动得到的文档的来源。】例：表X引用文档文档标识文档名称发布日期版本号GJB438B-2009武器系统软件开发文档2009--HL1A-00CZC-09XXXXXX操作程序2000.81.0XXX-YYY-021XXXX接口控制文件XX分册2000.81.0XXX.XX.CCCCXXXXX系统软件需求规格说明2000.81.03CSCI级设计决策【本章应根据需要分条给出CSCI级设计决策，即CSCI行为设计的决策（忽略其内部实现，从用户角度出发描述系统将怎样运转以满足需求）和其它影响组成该CSCI的软件单元的选择与设计的决策。如果在需求中所有这些决策是明确的，或者这些决策要推迟到CSCI的软件单元的设计时指出，则本章应如实陈述。针对关键性需求（例如对安全性或保密性关键的需求）作出的设计决策，应在专门的章节中加以叙述。如果设计决策依赖于系统状态或方式，则应指明这一依赖性。本条应给出或引用理解这些设计所需的设计约定。CSCI级设计决策的例子如下：a）关于CSCI将接收的输入和将产生的输出的设计决策，包括与其它系统、HWCI、CSCI和用户的接口（本文档的4.3.X条指出本说明要考虑的主题）。如果这一信息的全部或部分已在接口设计说明（IDDs）中给出，则可以直接引用。b）有关响应每个输入或条件的CSCI行为的设计决策，包括CSCI要执行的动作、响应时间和其它性能特性，模型化的物理系统的说明，选定的方程式/算法/规则，以及对不允许的输入或条件进行的处理。c）有关数据库/数据文件如何呈现给用户的设计决策（本文档的4.3.X节标识了本说明要考虑的主题）。如果这一信息的全部或部分在数据库设计说明（DBDD）中给出，则可直接引用。2d）为满足安全性和保密性需求所选择的方法。e）为满足需求所做的其它CSCI级设计决策，例如为提供所需的灵活性、可用性和可维护性所选择的方法。】示例1：从两种技术解决方案中选出一种：XXXXXX。输入响应设计决策：对于待处理目标，收到目标侦测设备送来的待处理目标后，利用目标识别库识别确定目标的敌我属性，并进行威胁目标报告。安全性设计方法：在原系统的基础上，增加安全内核，实现身份认证和密码保护。可用性设计方法：利用双机热备份，24小时不停机，实现系统的可用性。例2：序号系统状态、方式和工作时序输入处理输出1程序初始化自检状态2状态传输中断状态3跟踪同步中断状态44CSCI体系结构设计【本章应分为以下几条描述CSCI体系结构设计。如果设计的全部或部分依赖于系统的状态或方式，此依赖性应予指明。如果设计信息在多于一个条中出现，它只需被提供一次，而在其它条中引用。本条应提供或引用为了理解设计所需要的设计约定。】4.1CSCI部件【本条应描述：a）构成该CSCI的所有软件单元。应赋予每个软件单元一个项目唯一的标识符。注：软件单元是CSCI设计中的一个元素；例如，CSCI的一个主要分支、该主要分支的一个组成部分，一个类、对象、模块、函数、例程或数据库。软件单元可以出现在层次结构的不同层上，且又可以由其它软件单元组成。在设计中，软件单元与实现它们的代码和数据实体（例程，过程，数据库，数据文件等），或与包含这些实体的计算机文件之间，可以有、也可以没有一对一的对应关系。一个数据库可被处理为一个CSCI也可被处理为一个软件单元。SDD可以采用与所使用设计方法相一致的任何名字来称呼软件单元。b）软件单元的静态（如，由…组成）关系。根据所选择的软件设计方法学，可以给出多种关系（例如，采用面向对象的设计方法时，本条既可给出类和对象结构，也可给出CSCI的模块和过程结构）。c）每个软件单元的用途，指明分配给它的CSCI需求和CSCI级设计决策（需求的分配也可在6a）中提供）。d）每个软件单元的开发状态/类型（如新开发、按原样重用已有的设计或软件、再工程的已有的设计或软件、为重用而要开发的软件等，为构建版N计划的软件）。针对现有的设计或软件，本说明应提供标识信息，例如名字、版本、文档引用、库等。e）CSCI（若适用，针对每个软件单元）计划使用的计算机硬件资源（例如处理机能力，内存能力，输入/输出设备能力，辅存能力以及通信/网络设备能力）。本说明应覆盖3CSCI的资源使用需求中、影响该CSCI的系统级资源分配中、