1专题资料（2021-2022年）.接口控制文件模版.doc

XXXXXX公司 技 术 文 件

文件名称：XXXXXXXXX接口控制文件
文件编号：
项目名称：
项目编号：
物料编码：
文件密级：秘密
受控标识：
第 1 册
共 7 页
共 1 册
版本
状态
拟制
审核
批准
批准日期
修订信息
A

相关部门/人员会签：
文件
发放
（接收文件的部门或人员）

替换旧版文件；替换：

1

文件修订页
编
号
章节
名称
修订内容简述
修订
日期
订前
版本
订后
版本
修订人
批准人
1

2

目 录
1 范围 1
1.1 系统概述 1
1.2 文档概述 1
1.3 术语与缩略语 1
2 引用文档 1
3 接口设计 1
3.1外部接口 1
3.2用户接口 2
3.3内部接口 2

1 范围
1.1 系统概述
描述软件系统的运行环境、主要用途，描述软件系统的总体功能、构成、子系统构成。使得读者对系统有一个总体的概要的了解。
[读者看完系统概述知道了这个软件是做什么用的、主要的功能是什么，用在什么样的场合。这样读者就可以对系统有一个整体的了解]。
1.2 术语与缩略语
本文档使用的术语与缩略语：
XXXX ：XXXXXXXXXXXX；
……；
2 引用文档
[1]《XXXXXXX》，XXXXXXXXXX，YYYY年MM月。
[2]《XXXXXXX》，XXXXXXXXXX，YYYY年MM月。
……。
3 接口设计
3.1外部接口
说明该系统同外界的所有接口安排，包软件接口与硬件接口。
<说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。>
例如：通讯接口、直接硬件接口、支撑软件接口以及与其它软件模块间的接口设计。
1）外部网络通讯接口设计
外部通讯网络接口设计是指与本系统范围外的网络接口，如上层管理网等的接口和协议、信息流向、信息、长度和通讯周期等。
2）外部串行口通讯接口设计
外部串行口通讯接口设计是指与本系统范围外的其它系统采用串行口通讯时的接口关系，包括通讯协议(握手方式、波特率、校验方式等)、信息流向、信息长度和通讯周期等。还应说明当通讯过于频繁或超时时的措施。
3）与各支持软件的接口设计
指本软件要用到的支持软件的接口设计。如数据库管理服务接口，画面信息库，控制算法、接口设计等。
4）外部软件模块通讯接口设计
如果本软件还要与其它子系统通讯时，应定义本软件与其它软件模块间的接口关系。包括启动、被启动方式、输入和输出信息的介质及其格式。
5）直接硬件接口设计
指本软件要针对其直接编程的硬件接口设计。如过程PIO板等的接口设计、专用键盘的编码设计等。
3.2用户接口
<说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。>
例如：用户接口一般要包括用户操作过程(人机会话)设计、显示画面设计和打印报表设计等。
1）用户操作过程设计
用户操作过程设计一般包括以下内容：
l 专用键盘定义(如果用到专用键盘的话)；
l 用户对话过程设计(包括功能键定义，菜单条、屏幕按钮等设计)；
l 操作提示和错误提示信息设计；
2）显示画面设计
显示画面设计包括：
l 屏幕划分，窗口设计；
l 显示参数格式、状态、颜色定义显示信息格式、状态、颜色定义；
3）打印信息接口设计
打印信息接口设计包括：
l 打印驱动方式(定时、随机、事件驱动等)；
l 打印页面设计，如表头内容、表格行数、内容等；
l 表格打印参数格式，如长度、小数位数等；
l 信息打印格式，如信息内容、变量格式等；
3.3内部接口
<说明本系统之内的各个系统元素之间的接口的安排。标识系统中高层的不同人员之间的接口。每个内部接口应当用名称和项目唯一标识号加以标识，并简要描述每个接口，包括在接口上传递的信息提要。为了帮助说明，可使用描述数据流、控制流和其它有关信息的内部接口图。>
例如：内部接口设计包括文件、进程或线程之间的通信关系（含数据定义和驱动）。
1）文件定义
系统中不同任务之间的文件定义，包括：
l 名称，如：错误日志文件；
l 符号，如：IF_ERRLOG；
l 说明，如：用于记录系统中出错时报告的日志详细；
l 来源，如：A、B、C进程；
l 使用，如：操作员，D进程；
l 格式，如：结构定义或表格定义，说明类型和精度和取值范围；
l 备注，如：正文文件，按行存储，存储在共享目录share中。
2）数据接口
系统中进程或线程之间的通信关系，包括：
l 名称，如：接收数据；
l 符号，如：ID_RECDATA；
l 说明，如：用于传递接收数据；
l 来源，如：A进程；
l 使用，如：B进程；
l 格式，如：INT；
l 备注，如：数据测量单位，s(秒)、m(米)、kHz(千赫)；值域（若为常数，则提供实际值）；标识数据元素所需的精度。
3）驱动信号
系统中进程或线程之间的驱动关系，包括：
l 名称，如：发送数据信号；
l 符号，如：IM_SENDINFO；
l 说明，如：用于通知发送进程发送数据；
l 来源，如：进程组织好数据后置；
l 使用，如：B进程收到这个信号后读取XXXX缓冲区发送数据，之后清除；
l 定义，如：电文格式；
l 备注，如：信号灯，为1表示有数据，为0表示没有数据。

l 推荐用表格的形式定义这些接口，使用表格形式时请使用后面的格式；

序号
符号
名称
说明
来源
使用
定义
备注
1
IM_SENDINFO
发送数据信号
用于通知发送进程发送数据
A
B
电文格式
信号灯，为1表示有数据，为0表示没有数据。