《软件设计说明编写指南(438B)》由会员分享，可在线阅读，更多相关《软件设计说明编写指南(438B)（16页珍藏版）》请在金锄头文库上搜索。
1、密级： （软件项目名称）软件设计说明 标 识： 版 本：页 数：拟 制：SQA审核：审 核：批 准：拟制部门：XXXXXXXXXX研究所年月日修改文档历史记录：日 期版本说 明修改人目 录1 范围11.1 标识11.2 系统概述11.3 文档概述12 引用文档13 CSCI级设计决策14 CSCI体系结构设计24.1 CSCI部件24.1.1 CSCI结构34.1.2 CSC描述34.1.2.1 CSC名称和项目唯一标识号34.1.3 系统状态和模式44.2 执行方案44.2.1 CSC数据流与控制流图44.2.2 系统状态与模式的数据流与控制流54.3 接口设计64.3.1 接口设计准则64
2、.3.2 接口标识和接口图64.3.X（接口的项目唯一的标识符）75 CSCI详细设计95.X（软件单元的项目唯一的标识符，或者一组软件单元的标志符）96 需求可追踪性127 注释121 范围1.1 标识【本条应描述本文档所适用的系统和软件的完整标识，适用时，包括其标识号、名称、缩略名、版本号及发布号。】1.2 系统概述【本条应概述本文档所适用的系统和软件的用途。它还应描述系统与软件的一般特性；概述系统开发、运行和维护的历史；标识项目的需方、用户、开发方和保障机构等；标识当前和计划的运行现场；列出其它有关文档。】1.3 文档概述【本条应概述本文档的用途和内容，并描述与它的使用有关的保密性方面的
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.03 CSCI
4、级设计决策【本章应根据需要分条给出CSCI级设计决策，即CSCI行为设计的决策（忽略其内部实现，从用户角度出发描述系统将怎样运转以满足需求）和其它影响组成该CSCI的软件单元的选择与设计的决策。如果在需求中所有这些决策是明确的，或者这些决策要推迟到CSCI的软件单元的设计时指出，则本章应如实陈述。针对关键性需求（例如对安全性或保密性关键的需求）作出的设计决策，应在专门的章节中加以叙述。如果设计决策依赖于系统状态或方式，则应指明这一依赖性。本条应给出或引用理解这些设计所需的设计约定。CSCI级设计决策的例子如下：a）关于CSCI将接收的输入和将产生的输出的设计决策，包括与其它系统、HWCI、CS
5、CI和用户的接口（本文档的4.3.X条指出本说明要考虑的主题）。如果这一信息的全部或部分已在接口设计说明（IDDs）中给出，则可以直接引用。b）有关响应每个输入或条件的CSCI行为的设计决策，包括CSCI要执行的动作、响应时间和其它性能特性，模型化的物理系统的说明，选定的方程式/算法/规则，以及对不允许的输入或条件进行的处理。c）有关数据库/数据文件如何呈现给用户的设计决策（本文档的4.3.X节标识了本说明要考虑的主题）。如果这一信息的全部或部分在数据库设计说明（DBDD）中给出，则可直接引用。d）为满足安全性和保密性需求所选择的方法。e）为满足需求所做的其它CSCI级设计决策，例如为提供所需
6、的灵活性、可用性和可维护性所选择的方法。】示例1：从两种技术解决方案中选出一种：XXXXXX。输入响应设计决策：对于待处理目标，收到目标侦测设备送来的待处理目标后，利用目标识别库识别确定目标的敌我属性，并进行威胁目标报告。安全性设计方法：在原系统的基础上，增加安全内核，实现身份认证和密码保护。可用性设计方法：利用双机热备份，24小时不停机，实现系统的可用性。例2：序号系统状态、方式和工作时序输入处理输出1程序初始化自检状态2状态传输中断状态3跟踪同步中断状态44 CSCI体系结构设计【本章应分为以下几条描述CSCI体系结构设计。如果设计的全部或部分依赖于系统的状态或方式，此依赖性应予指明。如果
7、设计信息在多于一个条中出现，它只需被提供一次，而在其它条中引用。本条应提供或引用为了理解设计所需要的设计约定。】4.1 CSCI部件【本条应描述：a）构成该CSCI的所有软件单元。应赋予每个软件单元一个项目唯一的标识符。注：软件单元是CSCI设计中的一个元素；例如，CSCI的一个主要分支、该主要分支的一个组成部分，一个类、对象、模块、函数、例程或数据库。软件单元可以出现在层次结构的不同层上，且又可以由其它软件单元组成。在设计中，软件单元与实现它们的代码和数据实体（例程，过程，数据库，数据文件等），或与包含这些实体的计算机文件之间，可以有、也可以没有一对一的对应关系。一个数据库可被处理为一个CS
8、CI也可被处理为一个软件单元。SDD可以采用与所使用设计方法相一致的任何名字来称呼软件单元。b）软件单元的静态（如，由组成）关系。根据所选择的软件设计方法学，可以给出多种关系（例如，采用面向对象的设计方法时，本条既可给出类和对象结构，也可给出CSCI的模块和过程结构）。c）每个软件单元的用途，指明分配给它的CSCI需求和CSCI级设计决策（需求的分配也可在6 a）中提供）。d）每个软件单元的开发状态/类型（如新开发、按原样重用已有的设计或软件、再工程的已有的设计或软件、为重用而要开发的软件等，为构建版N 计划的软件）。针对现有的设计或软件，本说明应提供标识信息，例如名字、版本、文档引用、库等。
9、e）CSCI（若适用，针对每个软件单元）计划使用的计算机硬件资源（例如处理机能力，内存能力，输入/输出设备能力，辅存能力以及通信/网络设备能力）。本说明应覆盖 CSCI的资源使用需求中、影响该CSCI的系统级资源分配中、以及在软件开发计划（SDP）的资源使用测量策划的中包含的全部计算机硬件资源。如果针对给定计算机硬件资源的所有使用数据都在同一处提供，例如在SDD中提供，那么本条可直接引用。对每个计算机硬件资源，应包括如下信息：1）得到满足的CSCI需求或系统级资源分配；2）使用数据基于的假设和条件（例如，典型用法、最坏情况用法、特定事件的假定）；3）影响使用的特殊考虑（例如，虚存、覆盖、多处理
10、器的使用情况，操作系统、库软件的开销或其它实现开销影响）；4）所使用的测度的单位（例如，处理器能力的百分比、周期/秒、内存字节数、千字节/秒）；5）进行评估或测量的级别（例如，软件单元，CSCI或者可执行程序）。f）标识实现每个软件单元的软件放置在哪个程序库中。】示例：4.1.1 CSCI结构4.1.2 CSC描述4.1.2.1 CSC名称和项目唯一标识号注：从4.1.2.1开始，按照4.1.1图中的CSC层次关系进行编号。表2 （CSC名称）描述CSC名称CSC标识CSC用途下一级CSC组成设计决策CSC分配需求设计需求设计约束开发类型/状态注：a. 如该CSC不包含下一级CSC可标注为“无
11、”，否则逐个说明下一级的CSC名称。b. “分配需求”为需求规格说明分配给CSC的功能、性能、安全、保密等方面需求，可引用需求文档相关描述或名称标识；c. “设计需求”是从设计者的角度描述该CSC为实现分配需求而使用的关键算法、模型、容错处理等方面需求；d. “设计约束”是从设计者的角度描述实现该CSC所受到的软、硬件环境的限制，如数据范围、字长限制等；e. “开发类型/状态”是指新开发、按原样重用已有的设计或软件、再工程的已有的设计或软件、为重用而要开发的软件、为构建版N计划的软件等。f. 如CSC由下一级CSC组成，分配需求、设计需求、设计约束内容可引用下一级CSC相关描述，不必重复描述；
12、g. 对于关键或安全性等方面有较高要求的CSC，如有必要可针对不同分配需求逐条描述对应的设计需求、设计约束：4.1.3 系统状态和模式 表X 系统状态和模式系统状态和模式执行的CSCCSC名称CSC特殊性说明注：a. 如系统不存在多种状态和方式，本节可省略；b. 如某状态和方式下对应在CSC的全部功能，则只给出CSC名称，无需进行“CSC特殊性说明”，否则描述其功能、性能等方面的限制。目标识别和决策制定软件的系统状态和模式如下表所示：表x 系统状态和模式系统状态和模式执行的CSCCSC名称CSC特殊性说明作战方式控制命令处理只处理系统作战方式的开始/停止控制命令。目标参数处理该模块将从目标侦测
13、设备获取待处理目标参数。其它模块无。训练方式控制命令处理只处理系统训练方式的开始/停止控制命令。目标参数处理该模块将从模拟目标库中获取待处理目标参数。其它模块无。4.2 执行方案【本条应说明软件单元间的执行方案。可采用图表和描述，来说明软件单元间的动态关系，即CSCI运行期间软件单元间的相互作用情况，（若适用）应包括执行控制流程、数据流、动态控制序列、状态转换图、时序图、单元间的优先关系、中断处理、时序/排序关系、例外处理、并发执行、动态分配与去除分配、对象/进程/任务的动态创建/删除、以及动态行为的其它方面。】示例：4.2.1 CSC数据流与控制流图a)敌我目标识别的数据流图b)敌我目标识别的执行控制流图4.2.2 系统状态与模式的数据流与控制流目标识别和决策制定软件在作战方式下的控制流图如下：控制流图描述：系统运行在作战方式时，接收飞行员输入的系统控制命令控制系统状态。系统在开启状态下，接收目标参数并进行敌我属性识别，并上报威胁目标给飞行员。根据威胁目标信息进行对敌行动决策，制定并上报行动方案。目标识别和决策制定软件在作战方式下的数据流图如下所示：
