GJB438B 接口设计说明IDD 模板.doc

《GJB438B 接口设计说明IDD 模板.doc》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、[键入文字]文档标识及版本号：XX项目标识.IDDV1.0密级：秘密★5年编制/修订日期：yyyy-mm-dd文档名称：XX项目中文名称-接口设计说明接口设计说明《XX项目》接口设计说明编制单位：编写：审核：批准：修改记录序号修改时间修改说明（修改章节及内容概要）修改人yyyy-mm-dd目录1范围11.1标识11.2系统概述11.3文档概述12引用文档23接口设计23.1接口标识和接口图23.X(接口的项目唯一的标识符)34需求的可追踪性65注释7iiiiXX项目-接口设计说明IDD密级：秘密★5年1范围1.1标识【本条应描述本文档所适用的系统、接口实体和接口

2、的完整标识，适用时，包括其标识号、名称、缩略名、版本号和发布号。】表1-1本文档所适用的系统、接口实体和接口序号名称缩略名标识号版本号发布号1.2系统概述【本条应概述本文档所适用的系统和软件的用途，还应描述系统与软件的一般特性；概述系统开发、运行和维护的历史；标识项目的需方、用户、开发方和保障机构等；标识当前和计划的运行现场；列出其他有关文档。】（本章若无内容，则标识为“本章无内容”，并说明理由。）1.3文档概述【本条应概述本文档的用途和内容，并描述与它的使用第7页，共7页XX项目-接口设计说明IDD密级：秘密★5年有关的保密性方面的要求。】（本章若无内容，则标

3、识为“本章无内容”，并说明理由。）2引用文档【本章应列出引用文档的编号、标题、编写单位、修订版及日期，还应标识不能通过正常采购活动得到的文档的来源。】（本章若无内容，则标识为“本章无内容”，并说明理由。）3接口设计3.1接口标识和接口图【对于1.1中所标识的每个接口，本条应描述赋予该接口的项目唯一的标识符，适当时应使用名称、编号、版本和文档引用等标识接口实体（系统、配置项、用户等）。该标识应说明哪些实体具有固定的接口特性（要给出这些接口实体的接口需求），哪些实体正被开发或修改（这些实体已有各自的接口需求）。适当时，可使用一个或多个接口图来描述这些接口。】（本章若

4、无内容，则标识为“本章无内容”，并说明理由。）第7页，共7页XX项目-接口设计说明IDD密级：秘密★5年3.X(接口的项目唯一的标识符)【本条（从3.2开始编号）应通过项目唯一的标识符标识接口，应简要标识接口实体，并且应根据需要分条描述接口实体的单方或双方的接口特性。如果一指定的接口实体没有在IDD中提及（例如，一个外部系统），而在本文档描述接口实体时需要提到其接口特征，则这些特征应作为假设予以陈述、或以“当[未涵盖的实体]这样做时，[所指定的实体]将……”的形式描述。本条可引用其他文档（例如，数据字典、协议标准、用户接口标准）代替本条的描述信息。若适用，本设计

5、说明应包括以下内容，可以任何适当于该信息的顺序提供，并应从接口实体角度，说明这些特性之间的区别（例如关于数据元素的大小、频率或其他特性的不同期望值）。a)接口实体分配给接口的优先级别。b)要实现的接口的类型（如：实时数据传送、数据的存储和检索等）。c)接口实体应提供、存储、发送、访问、接收的各个数据元素的特征，如：1）名称/标识符：a.项目唯一的标识符；b.非技术（自然语言）名称；第7页，共7页XX项目-接口设计说明IDD密级：秘密★5年a.数据元素名称；b.技术名称（如代码或数据库中的变量或字段名）；c.缩写名或同义名。1）数据类型（字母、数字、整数等）。2）

6、大小和格式（如：字符串的长度和标点符号）。3）计量单位（如：m）。4）可能值的范围或枚举（如：0-99）。5）准确度（正确程度）和精度（有效数字位数）。6）优先级别、时序、频率、容量、序列、其他的约束条件，如：数据元素是否可被更新、业务规则是否适用。7）保密性约束。8）来源（设置/发送实体）和接收者（使用/接收实体）。a)接口实体应提供、存储、发送、访问、接收的数据元素组合体（记录、消息、文件、显示、报表等）的特征，如：1）名称/标识符：a.项目唯一的标识符；b.非技术（自然语言）名称；c.技术名称（如代码或数据库中的记录或数据第7页，共7页XX项目-接口设计说

7、明IDD密级：秘密★5年结构）；a.缩写名或同义名。1）数据元素集合体中的数据元素及其结构（编号、次序、分组）。2）媒体（如盘）和媒体中数据元素/数据元素集合体的结构。3）显示和其他输出的视听特性（如：颜色、布局、字体、图标和其他显示元素、蜂鸣声、亮度等）。4）数据元素集合体之间的关系，如排序/访问特性。5）优先级别、时序、频率、容量、序列、其他的约束条件，如：数据元素集合体是否可以被修改、业务规则是否适用。6）保密性约束。7）来源（设置/发送实体）和接收者（使用/接收实体）。a)接口实体将为接口使用的通信方法的特征。如：1）项目唯一的标识符；2）通信链接/带宽

8、/频率/媒体及其特性；3