[文档] 接口设计说明书

ゞ浴缸里的玫瑰 2024-03-30 14:35 48阅读 0赞

### 1 范围 ###

#### 1.1 标识 ####

本条应描述本文档所适用的系统、接口实体和接口的完整标识，使用时，包括其标识号、名称、缩  
略名、版本号和发布号。

#### 1.2 系统概述 ####

本条应概述本文档适用的系统和软件的用途；描述系统和软件的一般特性（如规模、安全性、可靠  
性、实时性、技术风险等特性）；概述系统开发、运行和维护历史；标识项目的需方、用户、开发  
方和保障机构等；标识当前和计划的运行现场；列出其他有关文档。

#### 1.3 文档概述 ####

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

### 2 引用文档 ###

本章应引出引用文档的编号、标题、编写单位、修订版及日期，还应给出不能通过正常渠道得到的  
文档的来源。

### 3 接口设计 ###

本章应分为以下子条描述有一个或多个系统、子系统、配置项、人工操作、或其他系统部件的接口  
特性。如果设计部分或全部依赖系统状态或方式，应指明这种依赖关系。如果设计信息出现在若干  
条中，可表述一次，其他引用；如果其他文档中给出部分或全部该类信息，在此可以引用。本章应  
给出或引用需要了解的设计约定。

#### 3.1 接口标识和接口图 ####

对于1.1中所标识的每个接口，本条应描述赋予该接口的项目唯一的标识符，适当时应使用名称、编  
号、版本和文档引用等标识接口实体（系统、配置项、用户等）。该标识符用应说明哪些实体具有  
固定的接口特性（要给出这些接口实体的接口需求），哪些实体正被开发或修改（这些实体已有  
各自的接口需求）。适当时，可使用一个或多个接口图来描述这些接口。

#### 3.X （接口的唯一标识） ####

本条（从3.2开始编号）应通过项目唯一的标识符标识接口，应简要标识接口实体，并且应根据需要  
分条描述接口实体的单方或双方的接口特性。如果一指定的接口实体没有在IDD中提及（例如，一个  
外部系统），而在本文档描述接口实体时需要提到其接口特征，则这些特征应作为假设予以陈述、  
或以“当\[未涵盖的实体\]这样做时，\[所指定的实体\]将·····”的形式描述。本条可引用其他文档（例  
如，数据字典、协议标准、用户接口标准）代替本条的描述信息。若适用，本设计说明应包括以下  
内容，可以任何适用于信息的顺序提供，并应从接口实体角度，说明这些特性之间的区别（例如关  
于数据元素的大小、频率或其他特性的不同期望值）。  
\-接口实体分配给接口的优先级。  
\-所实现的接口类型（如实时数据传送、数据的存储和检索等）。  
\-接口实体所提供、存储、发送、访问和接收的各个数据元素的特征，如：  
1.名称/标识符：  
\-唯一标识符；  
\-非技术名称（自然语言名称）；  
\-数据元素名称（应优先使用标准化的数据元素名称）；  
\-技术名称（如系统中变量名称、数据库字段名称）；  
\-缩小名或同义名。  
2.数据类型（字母、数字、整数等）。  
3.大小和格式（如：字符串的长度）。  
4.计量单位（如：m）。  
5.可能值的范围或枚举（如：0~99）。  
6.准确度（正确程度）和精确（有效数字位数）。  
7.优先级、时序、频率、序列、其他的约束力条件，如：数据元素是否可被更新，业务规则是否适  
用。  
8.保密性约束。  
9.来源（建立/发送实体）和接收者（使用/接收实体）。  
\-接口实体所提供、存储、发送、访问、接收的数据元素组合体（记录、消息、文件、显示、报表  
等）的特征，如：  
1.名称/标识符；  
\-唯一标识符；  
\-非技术名称（自然语言名称）；  
\-技术名称（如系统中变量名称、数据库字段名称）；  
\-缩写名或同义名。  
2.组合体中的数据元素及其结构（编号、次序、分组）。  
3.介质（如光盘）和介质中数据元素/组合体的结构。  
4.显示和其他输出的视听特性（如：颜色、布局、字体、图标和其他显示元素、蜂鸣声、亮度等）。  
5.组合体之间的关系，如排序/访问特性。  
6.优先级、时序、频率、容量、序列、图标和其他约束条件，如：组合体是否可被修改、业务规则是  
否适用。  
7.保密性约束。  
8.来源（建立/发送实体）和接收者（使用/接收实体）。  
\-接口实体所使用的接口通信方法的特征。如：  
1.唯一标识符；  
2.通信链路/带宽/频率/介质及其特征；  
3.消息格式化；  
4.流控制（如：序列编号和缓冲区分配）；  
5.周期性/非周期性数据传送的速率、传输间隔；  
6.路由、寻址、命名约定；  
7.传输服务，包括优先级和等级；  
8.安全性/保密性方面的考虑，如：加密、用户鉴别、间隔、审核等。  
\-接口实体所使用的接口协议的特征，如：  
1.唯一标识符；  
2.协议的优/层次；  
3.打包（包括拆包和重新打包）、路由、寻址；  
4.合法性检查、错误控制和恢复过程；  
5.同步，包括连接的建立、维护、终止；  
6.状态、标识和其他需要报告的内容。  
\-其他要求的特征，如：接口实体的物理兼容性（尺寸、公差、负荷、电荷和接插件兼容性等）。

### 4 需求的可追踪性 ###

本章应描述：  
\-从本文档中每个接口实体到相应的系统或计算机软件配置项需求之间的可追踪性；  
\-从影响本文档接口的每个系统或计算机软件配置项需求到相应接口实体之间的可追踪性。

### 5 注释 ###

本章应包括有助于了解文档的所有信息（例如：背景、术语、缩略语或公式）。