完整word版软件设计说明编写指南438B.docx

完整word版软件设计说明编写指南438B.docx

《完整word版软件设计说明编写指南438B.docx》由会员分享，可在线阅读，更多相关《完整word版软件设计说明编写指南438B.docx（24页珍藏版）》请在冰点文库上搜索。

完整word版软件设计说明编写指南438B

密级:

（软件项目名称）

软件设计说明

标

识:

版

本:

页

数:

拟

制:

SQA审核:

审

核:

批

准:

拟制部门:

中国人民

XXXXXXXXXX研究所解放军

修改文档历史记录:

修改人

日期版本

1yLLI韦I•・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・1

1・1•・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・1

1.2系统概述1

1・3・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・1

2勺IJ11*1*^•・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・•・・・•・・・・・・・・・・・・・・・・・・・・・・・・・・・•・・・•・・・・・・・・・・•・・・•・・・・・・・・・・・・・・・・・・・・・・・・・・・•・・・•・・・・・・・・・・•・・・•・1

3CSCI级设计决策1

4CSCI体系结构设计2

4・1CSCI部彳牛2

•1・1I彳"J・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・3

4.1.2CSC描述3

4.1.2.1CSC名称和项目唯一标识号3

4・1・3勿葩彳大?

【】彳奠4

4.2执行方案4

4.2.1CSC数据流与控制流图5

4.2.2系统状态与模式的数据流与控制流5

4.3接口设计6

4•3・1I1"L'l'贝!

J

4.3.2接I丨标识和接I丨图6

4.3.X（接口的项目唯一的标识符）7

5CSCI详细设计10

5.X（软件单元的项目唯一的标识符，或者一组软件单元的标志符）10

6需求可追踪性12

7注释12

1范围

1.1标识

【本条应描述本文档所适用的系统和软件的完整标识，适用时，包括•其标识号、名称、缩略名、版本号及发布号。

】

1・2系统概述

【本条应概述本文档所适用的系统和软件的用途。

它还应描述系统与软件的一般特性;概述系统开发、运行和维护的历史；标识项目的需方、用户、开发方和保障机构等；标识当前和计划的运行现场；列出其它有关文档。

】

1.3文档概述

【本条应概述本文档的用途和内容，并描述与它的使用有关的保密性方面的要求。

】

例：

本文档描述XXXX系统软件的概要设计和详细设计，其内容和格式遵循GJB438B-2009的要求。

本文档可作为设计评审的基础，编码的依据，软件测试的基准。

2引用文档

【本章应列出引用文档的编号、标题.编写单位、修订版本及口期。

还应标识不能通过正常采购活动得到的文档的来源。

1

例：

表X引用文档

文档标识

文档名称

发布口期

版本号

GJB138B-2009

武器系统软件开发文档

2009

——

HL1A-00CZC-09

XXXXXX操作程序

2000.8

1.0

XXX-YYY-021

XXXX接口控制文件XX分册

2000.8

1.0

XXX.XX.CCCC

XXXXX系统软件需求规格说明

2000.8

1.0

3CSCI级设计决策

【本章应根据需要分条给出CSCI级设计决策，即CSCI行为设计的决策（忽略其内部实现，从用户角度出发描述系统将怎样运转以满足需求）和其它影响组成该CSCI的软件单元的选择与设计的决策。

如果在需求中所有这些决策是明确的，或者这些决策要推迟到CSCI的软件单元的设计时指出，则本章应如实陈述。

针对关键性需求（例如对安全性或保密性关键的需求）作出的设计决策，应在专门的章节中加以叙述。

如果设计决策依赖于系统状态或方式，则应指明这一依赖性。

本条应给出或引用理解这些设计所需的设计约定。

CSCI级设计决策的例子如下：

a）关于CSCI将接收的输入和将产生的输出的设计决策，包括与其它系统、HWCI、CSCI

和用户的接1丨（本文档的4.3.X条指出本说明要考虑的主题）。

如果这一信息的全部或部分己在接II设计说明（IDDs）中给出，则可以直接引用。

b）有关响应每个输入或条件的CSCI行为的设计决策，包括•CSCI要执行的动作、响应时间和其它性能特性，模型化的物理系统的说明，选定的方程式/算法/规则，以及对不允许的输入或条件进行的处理。

c）有关数据库/数据文件如何呈现给用户的设计决策（本文档的4.3.X节标识了本说明要考虑的主题）。

如果这一信息的全部或部分在数据库设计说明（DEDD）中给出，则可直接引用。

d）为满足安全性和保密性需求所选择的方法。

e）为满足需求所做的其它CSCI级设计决策，例如为提供所需的灵活性、可用性和可维护性所选择的方法。

】

示例1:

从两种技术解决方案中选出一种：

XXXXXXo

输入响应设计决策：

对于待处理目标，收到目标侦测设备送来的待处理目标后，利用目标识别库识别确定目标的敌我属性，并进行威胁目标报告。

安全性设计方法：

在原系统的基础上，增加安全内核，实现身份认证和密码保护。

可用性设计方法：

利用双机热备份，24小时不停机，实现系统的可用性。

例2：

序号

系统状态、方式

和工作时序

输入

处理

输出

1

程序初始化自检状态

2

状态传输中断状

态

3

跟踪同步中断状

态

4

4CSCI体系结构设计

【本章应分为以下几条描述CSCI体系结构设计。

如果设计的全部或部分依赖于系统的状态或方式，此依赖性应予指明。

如果设计信息在多于一个条中出现，它只需彼提供一次，而在其它条中引用。

本条应提供或引用为了理解设计所需要的设计约定。

］

4.1CSCI部件

【本条应描述：

a）构成该CSCI的所有软件单元。

应赋予每个软件单元一个项目唯一的标识符。

注：

软件单元是CSCI设计中的一个元素：

例如，CSCI的一个主要分支、该主要分支的一个组成部分，一个类、对彖、模块、函数、例程或数据库。

软件单元可以出现在层次结构的不同层上，且又可以由其它软件单元组成。

在设计中，软件单元与实现它们的代码和数据实体（例程，过程，数据库，数据文件等），或与包含这些实体的计算机文件之间，可以有、也可以没有一对一的对应关系。

一个数据库可被处理为一个CSCI也可被处理为一个软件单元。

SDD可以采用与所使用设计方法相一致的任何名字来称呼软件单元。

b）软件单元的静态（如，由…组成）关系。

根据所选择的软件设计方法学，可以给出多种关系（例如，采用面向对彖的设计方法时，本条既可给出类和对象结构，也可给出CSCI的模块和过程结构）。

c）每个软件单元的用途，指明分配给它的CSCI需求和CSCI级设计决策（需求的分配也可在6"中提供）。

d）每个软件单元的开发状态/类型（如新开发、按原样重用已有的设计或软件、再工程的已有的设计或软件、为重用而要开发的软件等，为构建版N计划的软件）。

针对现有的设计或软件，本说明应提供标识信息，例如名字、版本、文档引用、库等。

e）CSCI（若适用，针对每个软件单元）计划使用的计算机硕件资源（例如处理机能力，内存能力，输入/输出设备能力，辅存能力以及通信/网络设备能力）。

本说明应覆盖

CSCI的资源使用需求中、影响该CSCI的系统级资源分配中、以及在软件开发计划

（SDP）的资源使用测量策划的中包含的全部计算机硬件资源。

如果针对给定计算机硕件资源的所有使用数据都在同一处提供，例如在SDD中提供，那么本条可直接引用。

对每个计算机硕件资源，应包括如下信息：

1）得到满足的CSCI需求或系统级资源分配；

2）使用数据基于的假设和条件（例如，典型用法、最坏情况用法、特定事件的假定）;

3）影响使用的特殊考虑（例如，虚存、覆盖、多处理器的使用情况，操作系统、库软件的开销或其它实现开销影响）；

4）所使用的测度的单位（例如，处理器能力的百分比、周期/秒、内存字节数、千字节/秒）；

5）进行评估或测量的级别（例如，软件单元，CSCI或者可执行程序）。

f）标识实现每个软件单元的软件放置在哪个程序库中。

】

示例：

4.1.1

CSCI结构

注：

如该CSC不包含卞一级CSC可标注为“无”,否则逐个说明卞一级的CSC名称。

4.1.2CSC描述

CSC名称

CSC标识

CSC用途

下一级

CSC组成

设计决策

CSC分配需求

设计需求

设计约束

开发类型/状态

4.1.2.1CSC名称和项目唯一标识号

注：

从4.1.2.1开始，按照4・1・1图中的CSC层次关系进行编号。

表2（CSC名称）描述

a.

b.“分配需求”为需求规格说明分配给CSC的功能、性能、安全、保密等方面需求，可引用需求文档相关描述或名称标识；

C.“设计需求”是从设计者的角度描述该CSC为实现分配需求而使用的关键算法、模型.容错处理等方面需求；

d・“设计约束”是从设计者的角度描述实现该CSC所受到的软、硕件环境的限制，如数据范围、字长限制等；

e.“开发类型/状态”是指新开发、按原样重用己有的设计或软件、再工程的已有的设计或软件、为重用而要开发的软件.为构建版N计划的软件等。

f.如CSCFh下一级CSC组成，分配需求、设计需求、设计约束内容可引用下一级CSC相关描述，不必重复描述；

g.对于关键或安全性等方面有较高要求的CSC,如有必要可针对不同分配需求逐条描述对应的设计需求、设计约束：

4.1.3系统状态和模式

表X系统状态和模式

系统状态和模式

执行的CSC

CSC名称

CSC特殊性说明

注：

a.如系统不存在多种状态和方式，本节可省略；

b.如某状态和方式卞对应在CSC的全部功能，则只给出CSC名称，无需进行“CSC特殊性说明”，否则描述其功能、性能等方面的限制。

目标识别和决策制定软件的系统状态和模式如卜表所示：

表X系统状态和模式

系统状态和模式

执行的CSC

CSC名称

CSC特殊性说明

作战方式

控制命令处理

只处理系统作战方式的开始/停止控制命令。

目标参数处理

该模块将从目标侦测设备获取待处理目标参数。

其它模块

无。

训练方式

控制命令处理

只处理系统训练方式的开始/停止控制命令。

目标参数处理

该模块将从模拟目标库中获取待处理目标参数。

其它模块

无。

4.2执行方案

【本条应说明软件单元间的执行方案。

可采用图表和描述，来说明软件单元间的动态关系，即CSCI运行期间软件单元间的相互作用情况，（若适用）应包括执行控制流程、数据流.动态控制序列.状态转换图、时序图.单元间的优先关系、中断处理.时序/排序关系、例外处理、并发执行、动态分配与去除分配、对象/进程/任务的动态创建/删除、以及动态行为的其它方面。

】

示例:

4.2.1CSC数据流与控制流图

R敌我目标识别的数据流图

4.2.2系统状态与模式的数据流与控制流

目标识别和决策制定软件在作战方式下的控制流图如下:

b）敌我目标识别的

控制流图描述：

系统运行在作战方式时,接收飞行员输入的系统控制命令控制系统状态。

系统在开启状态卞，接收目标参数并进行敌我属性识别，并上报威胁目标给飞行员。

根据威胁目标信息进行对敌行动决策，制定并上报行动方案。

目标识别和决策制定软件在作战方式下的数据流图如下所示:

X作战方武数据流国

4.3接口设计

4.3.1接II设计准则4.3.2接II标识和接I1图

【本条应说明赋予每个接II的项目唯一的标识符，（若适用）应通过名称、编号、版本及文档引用来标识接II实体（软件单元、系统、配置项、用户等）。

该标识应说明哪些实体具有固定的接II特性（从而把接门需求分配给这些接II实体）；说明哪些实体正在开发或修改（这些实体己有各自的接II需求）。

（若适用）应通过接II图来描述这些接II。

】

目标识别库加/

表X顶层模块内部接II描述

述接

酗述

运行状态

曲式

标数息目参信

1釁

敌我目标识别内部接II示意图

•敌我目标识别内部接II描述

表X敌我目标识别内部接II描述

SS

噩标

、类、績位频型熔方载类耐。

•更邮21U盼濒速复fiflM标离、抓目距型輔

4.3.X（接口的项目唯一的标识符）

【本条（从4.3.3开始）应通过项目唯一标识符来标识接「1,应简要地标识接【I实体，根据需要可分条描述单方或双方接II实体的特性。

如果一指定的接II实体未包含在本SDD

中（例如，一个外部系统），而描述接II实体需要提到其接II特性时，这些特性应作为假设予以陈述、或以“当［未涵盖的实体］这样做时，［所指定的实体］将……”的形式描述。

本条可引用其它文档（例如数据字典、协议标准、用户接II标准）代替在此所描述的信息。

本设计说明应包括•以下内容（若适用），以任何适合于所提供的信息的顺序提供，并应从接II实体角度说明这些特性之间的区别（例如关于数据元素的人小、频率或其它特性的不同期望值）：

a）接口实体分配给接口的优先级；

b）要实现的接II类型（例如实时数据传输、数据的存储和检索等）；

c）接II实体将提供、存储、发送、访问.接收的各个数据元素的特征，例如：

1）名称/标识符：

（1）项目唯一的标识符；

（2）非技术（自然语言）名称：

（3）数据元素名称；

（4）技术名称（如在代码或数据库中的变量名或字段名）；

（5）缩略名或同义名。

2）数据类型（字母、数字、整数等）；

3）大小与格式（如：

字符串的长度和标点符号）：

4）计量单位（如：

m等）;

5）可能值的范围或枚举（如：

0-99）；

6）准确性（正确程度）和精度（有效数位数）；

7）优先级、定时、频率、容量.序列以及其它约束条件（例如数据元素是否可以被更新、业务规则是否适用入

8）保密性约束。

9）来源（建立/发送的实体）和接受者（使用/接收的实体）。

d）接II实体将提供、存储、发送、访问、接收的数据元素集合体（记录、消息、文件、数组、显示、报表等）的特性，例如：

1）名称/标识符：

（1）项目唯一的标识符；

（2）非技术（自然语言）名称：

（3）技术名称（如在代码或数据库中的记录名或数据结构名）；

（4）缩略名或同义名。

2）数据元素集合体中的数据元素及其结构（编号、顺序和分组情况）；

3）介质（例如磁盘）以及介质上数据元素/数据集合体的结构；

4）显示和其它输出的视听特性（例如颜色、布局、字体、图标和其它显示元素、峰鸣声和亮度）；

5）数据组合体之间的关系，如排序/存取特性；

6）优先级、定时、频率.容量、序列及其它约束，例如数据组合体是否可被更新、业务规则是否适用；

7）保密性约束；

8）来源（建立/发送的实体）和接受者（使用/接收的实体）。

e）接口实体用于接口的通信方法的特征。

如：

1）项目唯一的标识符；

2）通信链接/带宽/频率/介质及其特性；

3）消息格式；

4）流控制（如:

序列编号和缓冲区分配）;

5）数据传输率、周期或非周期、传输间隔；

6）路由、寻址及命名约定；

7）传输服务，包括：

优先级和等级；

8）安全性/保密性考虑，如：

加密、用户鉴别.隔离和审核。

f）接口实体用于接II的协议的特征，如：

1）项目唯一的标识符；

2）协议的优先级别/层次；

3）打包，包拾分段与重组、路由和寻址：

4）合法性检查、错误控制和恢复过程：

5）同步，包扌舌连接的建立、保持和终止；

6）状态、标识和其它报告特性。

g）其它特性，例如接II实体的物理兼容性（尺寸、公差、负荷、电压和接插件的兼容性等）。

】

示例：

4.3.X.1数据元素

表X（接II）的数据元素

数据元素名称

数据元索标识

描述

数据类型

数据长度

测虽

单位

极限值/值域

精度

/分辨率

来源/接受者

目标标识

号

ADMS-SJYS-MBBS

标识目标的ID

无符号整数

4字节

无

广2”-1

无

来自“敌方目标匹配/我方目标匹配”

载频类型

ADMS-SJYS-ZPLX

未知目标的载频类型

无符号整型

4字节

无

0：

未知

1:

载频固定

2：

载频捷变

3：

载频分集

无

敌方目标匹配/我方目标匹配

载频上限

ADMS-SJYS-ZPSX

未知目标的载频上限

浮点型

4字节

MHz

0、9999・999

10'5

敌方目标匹配/我方目标匹配

载频下限

ADMS-SJYS-ZPXX

未知目标的载频下限

浮点型

4字节

MHz

0、9999・999

10'5

敌方EI标匹配/我方目标匹配

重复间隔类型

ADMS-SJYS-CFLX

未知目标的重复间隔类型

无符号整型

4字节

无

0：

未知

1：

重频固定2：

重频抖动3：

重频参差4：

重频组变

无

敌方目标匹配/我方目标匹配

重复间隔时间上限

ADMS-SJYS-CFSX

未知目标的重复间隔时间上限

浮点型

4字节

微秒

0、9999・999

10'5

敌方目标匹配/我方目标匹配

4.3.X.2数据结构

表数据消息描述

数据消息

描述

包含的数据元素/消息

名称

项目唯一标识号

名称

项目唯一标识号

武器装备信息

ADMS-SJXX-WQZB

描述目标挂载的武器的类型、数量和攻击范围

武器类型

ADMS-SJYS-WQMC

武器数量

ADMS-SJYS-WQSL

武器攻击范围

ADMS-SJYS-GJFW

威胁目标参数信息

ADMS-SJXX-MBCS

经过敌我属性识别的威胁目标参数信息。

目标标识号

ADMS-SJYS-MBBS

目标属性

ADMS-SJYS-DWSX

目标类型

ADMS-SJYS-MBLX

威胁等级

ADMS-SJYS-WXJB

方位角

ADMS-SJYS-F町

距离

ADMS-SJYS-MBJL

相对咼度

ADMS-SJYS-FXGD

武器装备信息

ADMS-SJXX-WQZB

5CSCI详细设计

5.X（软件单元的项目唯一的标识符，或者一组软件单元的标志符）

【本条应通过项目唯一的标识符来标识软件单元，并对该单元进行说明。

（若适用）该说明应包括下列信息。

本条也可以指定一组软件单元，然后再分小条对它们分别进行标识和说明。

包含其他软件单元的软件单元可引用那些软件单元的说明，而无需在此重复。

a）（若有）单元设计决策，例如所使用的算法（如果此前尚未选定）；

b）该软件单元设计中的任何约束、限定或非常规特征；

c）如呆使用的编程语言不同于该CSCI所指定的语言，则应指出并说明使用它的理由；

d）如果该软件单元包含过程性命令或由过程性命令组成（例如数据库管理系统（DBMS）

中用于定义表单和报表的菜单选择，用于数据库访问和操纵的在线DBMS查询，用于代码自动生成的图形用户接II（GUI）构造器的输入，操作系统的命令或Shell脚本），应列出这些过程性命令，并引用解释它们的用户手册或其它文档；

e）如果该软件单元包含、接收或输出数据，（若适用）应对它的输入、输出及其它数据元素和数据元素组合体进行说明。

本文档的4.3.X条提供了（若适用）应包括的主题。

软件单元的局部数据应与软件单元的输入或输出数据分开来描述。

如果该软件单元是一个数据库，应引用相应的数据库设计说明（DEDD）；接II特性可以在这里提供，也可以引用第4章或相应的接口设计说明（LDD）。

f）如呆该软件单元包含逻辑，给出该软件单元所用到的逻辑，（若适用）应包括：

1）该软件单元执行启动时，其内部起作用的条件；

2）将控制传递给其它软件单元的条件；

3）对每个输入的响应以及响应时间，包括数据转换、重命名以及数据传输操作；

4）在软件单元运行期间的操作顺序和动态控制序列，包括：

（1）顺序控制的方法；

（2）该方法的逻辑和输入条件，例如时序变异、优先级分配等；

（3）进出内存的数据传输；

（4）对离散输入信号的感知，以及该软件单元内中断操作之间的时序关系。

5）异常和错误处理。

】

示例:

CSC组成

CSC名称

CSC标识

小节号

CSU名称

CSU标识

CSU之间的关系

用控制流图或数据流图描述该CSC下的各CSU间的关系。

5.X.1（CSC名称）的设计

注：

从5.1.1开始编号。

描述4.X.Y节所标识的CSU的详细设计。

a.设计语言与库

表（CSU名称）的设计

CSU名称

CSU标识

使用的程序语言

使用该语言理由

保存CSU的库

库名称

库标识

描述库的设计文档

注：

1、如果CSU不是用CSCI规定语言编写，那么应在“使用的程序语言”项中标识要使

用的这一语言，并应在“使用该语言理由”项中给出使用它的理由。

2、如果CSU保存在库中，则描述相关信息，否则该列可删除。

3、如果该CSU在程序语言及库方面没有特殊性，本节可删除。

b.输入/输出元素

表输入/输出元素

元素名称

元素标识

数据类型

数据长度

测量单位

极限值/值域

精确度

精度/分辨率

用途

注：

这些数据的描述也可在第5章统一进行数据元素的属性列可根据实际情况进行剪裁。

“数据类型”包括整型（Int）、字符型（Char）、字符串、字母数字等等；

“测量单位”有秒、米、千赫等；

“极限值/值域”处用范围的形式（如10〜50）或最大、最小值的形式（如：

最人值为50,最小值为10〉给出；若为常数，则提供实际值；

“精度/分辨率”用有效数字（如10J标识；

“精确度”表示数据元素的