项目管理-接口设计文档模板.docx

《项目管理-接口设计文档模板.docx》由会员分享，可在线阅读，更多相关《项目管理-接口设计文档模板.docx（8页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、（产品名称）接口设计文档（宋体小初）.XX公司二OXX年XX月（宋体三号）xxxx接口设计说明a）从本文档中每个接口实体到相应的系统或计算机软件配置项需求之间的可追踪 性;b）从影响本文档接口的每个系统或计算机软件配置项需求到相应接口实体之间的 可追踪性。4注释说明:背景、术语、缩略语或公式（宋体二号）（宋体小二）（产品名称）接口设计文档XXX-JD-VX. X （软件设计加） 日期：校对：（软件设计师） 日期: （软件负责人） 日期:标审：（单位工程管理员） 日期:会签：（单位研发部门负货人） 日期: （工程技木负责人） 日期:（宋体三号）XXX （产品名称）功能特性分析报告（产品名称）接口

2、设计文档（宋体二号）XXX-JD-VX. X（宋体小二） 日期：校对： 日期： 日期：标审： 日期：会签： 日期： 日期：XXXX接口设计说明1范围11. 1 标识11.2 系统概述1文档概述11.3 引用文档12接口设计12.1 接 口 识和接 口 图 1（接口的工程唯一的标识符）23需求的可追踪性34注释4X X X X接口设计文档1范围1.1 标识说明:本条应包含本文档使用系统的完整标识,适用时,包括其标识号、名称、缩 略名、版本号和发布号。1.2 系统概述说明:本条应概述本文档所使用的系统的用途。它还应描述系统的一般特性;概述 系统开发、运行和维护的历史;标识工程的需方、用户、开发方和

3、保障机构等;标识当 前和计划的运行现场;列出其他有关文档。1.3 文档概述说明：本条应概述本文档的用途和内容,并描述与它的使用有关的保密性方面的要 求。1.4 引用文档例如：表 X X X X X X X2接口设计编号标题编写单位修订版日期来源接口标识和接口图xxxx接口设计说明说明:对1.1条中标识的每一个接口,本条应包含工程唯一标识符,（假设适用）应 通过名称、编号、版本和文档引用来指明接口实体（系统、配置项、用户等）。该标识 应声明哪些实体具有固定的接口特性（要给出这些接口实体的接口需求）;说明哪些实 体正在开发或修改之中（这些实体己有各自的接口需求）。可通过一张或多张接口图来 描述这些

4、接口。2.1 （接口的工程唯一的标识符）说明:本条（从3. 2开始）通过工程唯一标识符来标识接口,应简要地标识接口实 体。根据需要可分条描述为实现该接口而提出的一个或多个接口实体的需求。如果一个 实体的接口特性未包含在本1RS中、但是描述对该接口实体的需求时需要提到其接口特 性,这些特性应作为假定予以陈述，或以“当未涵盖的实体这么做时,所指定的实 体将”的形式描述,而不作为针对本1RS没有涵盖的实体的需求。本条可引用其 它文档（例如数据字典、通信协议标准、用户接口标准）代替在此所描述的信息。假设适 用,需求应包括如下内容,并以适合于需求的任何顺序给出,还应从接口实体的角发说 明这些特性之间的区

5、别（例如关于数据元素的大小、频率或其它特性的不同期望值）:a）接口实体必须分配给该接口的优先级。h）关于要实现的接口类型的要求（例如实时数据传送、数据的储存和检索等）。c）接口实体必须提供、储存、发送、存取、接收的各个数据元素所要求的特征。1）名称/标识符;2）数据类型（字母、数字、整数等）;3）大小和格式（如:字符串的长度和标点符号）;4）计量单位（如：m）；5）可能值的范围或枚举（如:099）；6）准确度（正确程度）和精度（有效数字位数）。7）优先级别、时序、频率、容量、序列、其他的约束条件，如:数据元素是 否可被更新、业务规那么是否适用:8）保密性约束;9）来源（设置/发送实体）和接收者

6、（使用/接收实体，d）接口实体必须提供、存储、发送、访问、接收的数据元素组合体（记录、消息、 文件、数组、显示、报表等）所要求的特征。1）名称/标识符;XXXX接口设计说明2）数据元素集合体中的数据元素及其结构;3）媒体（如盘）和媒体中数据元素/数据元素集合体的结构;4）显示和其他输出的视听特性（如:颜色、布局、字体、图表和其他显示元 秦蜂鸣声、亮度等）;5）数据元素集合体之间的关系，如排序/访问特性;6）优先级别、时序、频率、容量、序歹4、其他的约束条件,如：数据元素集 合体是否可被修改、业务规那么是否使用;7）保密性约束;8）来源（设置/发送实体）和接收者（使用/接收实体）。c）接口实体必

7、须使用的接口的通信方法所要求的特征。1）项R唯一的标识符;2）通信链接/带宽/频率/媒体及其特性;3）消息格式化;4）流控制（如:序列编号和缓冲区分配）;5）数据传送速率,周期性/非周期性,传输间隔:6）路由、寻址、命名约定;7）传输服务,包括优先级别和等级;8）平安性/保密性方面的考虑，如:加密、用户鉴别、隔离。审核等。f）接口实体必须使用的接口的协议所要求的特征。1）工程唯一的标识符;2）协议的优先级别/层次;3）打包,包括分段和重组、路由、寻址;4）合法性检查、错误控制和恢复过程;5）同步,包括连接的建立、维护、终止;6）状态、标识、任何其他报告特征。g）其他所要求的特征,例如接U实体的物理兼容性（尺寸、公差、负载和接插件的 兼容性等）、电压等。3需求的可追踪性说明:本章应描述: