接口设计说明IDD文档标准模版.docx
- 文档编号:24829175
- 上传时间:2023-06-01
- 格式:DOCX
- 页数:9
- 大小:24.41KB
接口设计说明IDD文档标准模版.docx
《接口设计说明IDD文档标准模版.docx》由会员分享,可在线阅读,更多相关《接口设计说明IDD文档标准模版.docx(9页珍藏版)》请在冰豆网上搜索。
接口设计说明IDD文档标准模版
文件版本
XXXX
版本/良改状态
VI,0
接口设计说明(IDD)
I/O
接口设计说明(IDD)
拟制
审核
复核
标准化审核
批准
XXXXX
xxxx公司
文件版本
XXXX
版本/良改状态
VI,0
接口设计说明(IDD)
I/O
文件更改记录
序号
版本号
更改日期
更改内容
更改
更改人
审核人
批准人
页码
条号
1
2
3
4
5
6
7
8
9
10
11
12
13
14
文件版本
XXXX
版本/良改状态
VI,0
接口设计说明(IDD)
I/O
文件版本变更记录
版本号
变更内容简述
签字
变更日期
变更人
审批
变更人
审批
变更人
审批
变更人
审批
变更人
审批
变更人
审批
变更人
审批
变更人
审批
文件版本
XXXX
版本/良改状态
VI,0
接口设计说明(IDD)
I/O
接口设计说明(IDD)
说明:
1.《接口设计说明》(IDD)描述了一个或多个系统或子系统、硬件配畫项HWCL计算柄款
件配鬣项CSCL手工操作或其他系统部件的接口特性。
一个IDD可以说明任何数量的接口。
2JDD可用于补充《系统/子系统设计(结构设计)说明XSSDD).《软件(结构)设计说明》(SDD)
和《数据库倾层)设计说明》(DBDD)。
IDD及其相伴的《接口壽求规格说明》(IRS)用于沟
通和控制接口的设计决策。
模版说明;
文档字体设定:
标题
1:
小一
标题
2:
—号
标题
3:
小二
标题
4:
■—O
—V
标题
5:
小三
标题6:
四号
正文:
四号
2、
3、
文章编号,请使用格式刷刷,不要手工编号。
目前格式都
是对的。
内容根据实际情况裁剪,一般可行性研究报告,模版章节
不可缺。
关于修订记录,请根据文档需要自行添加。
文件版本
XXXX
版本/良改状态
VI,0
接口设计说明(IDD)
I/O
le引言
本章分为以下几条。
1.1.标识
本条应包含本文档适用的系统、接口实体和接口的完整标识,(若适用)包括标识号、标题、缩略词语、版本号、发行号。
1.2.系统概述
本条应简述本文档适用的系统和软件的用途。
它应描述系统与软件的一般性质;概述系统开发、运行和维护的历史;标识项目的投资方,需方、用户、开发方和支持机构;标识当前和计划的运行现场;并列出其他有关文档。
1.3.文档概述
本条应概括本文档的用途与内容,刑a述与其使用有关的保密性或私密性要
求。
1.4.基线
说明编写本系统设计说明书所依据的设计基线。
文件版本
XXXX
版本/良改状态
VI,0
接口设计说明(IDD)
I/O
2.引用文件
本章应列出本文档引用的所有文档的编号、标题、修订版本和日期。
本童也应标识不能通过正常的供货渠道获得的所有文档的来源。
3.接口设计
本章应分条描述一个或多个系统、子系统、配置项、手工操作和其他系统部件的接口特性。
如果设计的部分或全部依赖于系统状态或方式,则应指出这种依赖性。
如果设计信息在多条中出现,则可只描述一次,而在其他条加以引用。
如果此信息的部分或全部在别处提供,则此处可以引用。
应给出或引用为了理解设计所需的iS计约定。
3.1.接口标识和接口图
对于1.1中所标识的每个接口,本条应陈述赋予该接口的项目唯一标识符,倍适用)并用名字、编号、版本和文档引用等标识接口实体(系统、配置项、用户等)。
该标识应说明哪些实体具有固定的接口特性(因而要对这些接口实体强加接口需求),哪些实体正被开发或修改(从而已将接口需求施加于它们)。
(若适用)可
用一个或多个接口图来描述这些接口。
323.X(接口的项目唯一标识符)
本条(从3.2开始编号)应通过项目唯一标识符标识接口,应简要标识接口实体,并且应根据需要划分为几条描述接口实体的单方或双方的接口特性。
如果一给定的接口实体本文没有提及(例如.—个外部系统),旦是其接口特性需要在本
文件版本
XXXX
版本/良改状态
VI,0
接口设计说明(IDD)
I/O
文描述的接口实体时提到,则这些特性应以假设、或"当[未提到实体]这样做时,[被提到的实体]将……”的形式描述。
本条可引用其他文档(例如数据字典、协议标准、用户接口标准)代替本条的描述信息。
(若适用)本设计说明应包括以下内容,它们可按适合于剽是供的信息的任何次序给岀,并且应从接口实体角度指出这些特性之间的区别(例如数据元素的大小、频率或其他特性的不同期望)。
a.接口实体分配给接口的优先级别;
b.要实现的接口的类型(如:
实时数据传送、数据的存储和检索等);
C.接口实体必须提供、存储、发送、访问、接收的单个数据元素的特性,如:
1)名称/标识符;
a)项目唯一标识符;
b)非技术(自然语言)名称;
C)标准数据元素名称;
d)技术名称(如代码或数据库中的变量或字段名称);
e)缩写名或同义名;
2)数据类型(字母数字、整数等);
3)大小和格式(如:
字符串的长度和标点符号);
4)计量单位(如:
米元、纳秒);
5)范围或可能值的枚举(如:
0-99);
6)准确度(正确程度)和精度(有效数字位数);
7)优先级别、时序、频率、容量、序列和其他的约束条件,如:
数据元素是否可被更新和业务规则是否适用;
8)保密性和私密性的约束;
9)来源(设置/发送实体)和接收者(使用/接收实体);
d.接口实体必须提供、存储、发送、访问和接收的数据元素集合体(记录、消息、文件、显示和报表等)的特性,如:
1)名称/标识符;
a)项目唯一标识符;
文件版本
XXXX
版本/良改状态
VI,0
接口设计说明(IDD)
I/O
b)非技术(自然语言)名称;
C)技术名称(如代码或数据库的记录或数据结构);
d)缩写名或同义名;
2)数据元素集合体中的数据元素及其结构(编号、次序和分组);
3)媒体(如盘)和媒体中数据元素/数据元素集合体的结构;
4)显示和其他输出的视听特性(如:
颜色、布局、字体、图标和其他显示元素、蜂鸣声、亮度等);
5)数据元素集合体之间的关系,如排序/访问特性;
6)优先级别、时序、频率、容量、序列和其他的约束条件,如:
数据元素集
合体是否可被修改、业务规则是否适用;
7)保密性和私密性约束;
8)来源(设置/发送实体)和接收者(使用/接收实体);e接口实体必须为接口使用通信方法的特性。
如:
1)项目唯一标识符;
2)通信链接侍宽/频率/媒体及其特性;
3)消息格式化;
4)流控制(如:
序列编号和缓冲区分配);
5)数据传送速率,周期性/非周期性,彳专输间隔;
6)路由、寻址、命名约定;
7)传输服务,包括优先级别和等级;
8)安全性/保密性/私密性方面的考虑,如:
加密、用户鉴别、隔离和审核等;
f.接口实体必须为接口使用协议的特性,如:
1)项目唯一标识符;
2)协议的优先级别/层次;
3)分组,包括分段和重组、路由、寻址;
4)合法性检查、错误控制和恢复过程;
5)同步,包括连接的建立、维护、终止;
文件版本
XXXX
版本/良改状态
VI,0
接口设计说明(IDD)
I/O
6)状态、标识、任何其他的报告特征;
g.其他所需的特性,如:
接口实体的物理兼容性(尺寸、容限、负荷、电压和關牛兼容性等)。
4.需求的可追踪性
本章应包括:
a从本文提到的每个接口实体到该实体的接口设计所涉及的系统或CSCI需求的可追踪性;
b.从影响本1DD所覆盖的接口的每个系统或CSCI需求到涉及它的接口实体的可追踪性。
5•注解
本章应包含有助于理解本文档的一般信息(例如背景信息、词汇表、原理)。
本童应包含为理解本文档所需要的术语和定义,所有缩略语和它们在本文档中的含义的字母序列表。
附录
附录可用来提供那些为便于文档维护而单独出版的信息(例如图表、分类数据)。
为便于处理,附录可单独装订成册。
附录应按字母顺序(A,B等)编排。
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 接口 设计 说明 IDD 文档 标准 模版