文档详情

(接口设计说明书模版.doc

发布:2017-01-09约1.09千字共8页下载文档
文本预览下载声明
接口设计说明书 保密文件 不得外传 文档修订记录 版本编号 *变化 状态 简要说明(变更内容和变更范围) 日期 变更人 批准日期 批准人 V0.1 建立 *变化状态:建立,修改,增加,删除 文档审批信息 序号 审批人 角色 审批日期 签字 备注 1 主 要 内 容 1 引言 1 1.1 编写目的 1 1.2 内容范围 1 1.3 读者对象 1 1.4 术语定义 1 1.5 参考资料 1 2 总体设计 2 2.1 接口应用模型 2 2.2 接口实现机制 2 2.3 传输控制 2 2.4 通信服务 2 2.5 性能设计 2 2.6 数据分析与校验 2 2.7 数据压缩与解压 2 2.8 数据交换分发 2 2.9 作业优先级设计 3 2.10 事务完整性 3 2.11 异常处理机制 3 2.12 人工干预 3 3 接口应用部署 3 4 功能模块设计一 3 4.1 功能列表 3 4.2 功能模块 3 4.2.1 功能描述 3 4.2.2 接口数据定义 3 4.2.3 接口流程 3 4.2.4 与其他模块关系 3 4.2.5 性能 3 4.2.6 异常机制 3 5 功能模块设计二 4 6 公共代码定义 4 引言 编写目的 [说明此文档的目的] 内容范围 [说明此文档包含的内容范围] 读者对象 [说明本文档的阅读对象] 术语定义 [说明本文档使用的术语的定义] 参考资料 [说明本文档的参考资料] 总体设计 接口应用模型 接口实现机制 基于消息和基于事务。交互的模型或者数据的模型。 传输控制 传输方式,根据数据量的大小。 通信服务 通信方式等描述 性能设计 负载均衡等。 数据分析与校验 数据压缩与解压 数据交换分发 (调度) 作业优先级设计 事务完整性 异常处理机制 人工干预 接口应用部署 功能模块设计一 功能列表 功能模块 功能描述 接口数据定义 接口流程 与其他模块关系 性能 异常机制 功能模块设计二 …… 公共代码定义 XX_XX_XXX_XXX XXXXXXXXXXXXXXXXX有限公司 接口设计说明书 8/8 XXXX-XX-XX
显示全部
相似文档