1.接口控制文件(模版).doc

XXXXXX 公司公司 技技 術(shù)術(shù) 文文 件件 文件名稱文件名稱 XXXXXXXXX接口控制文件 文件編號(hào)文件編號(hào) 項(xiàng)目名稱項(xiàng)目名稱 項(xiàng)目編號(hào)項(xiàng)目編號(hào) 物料編碼物料編碼 文件密級(jí) 文件密級(jí) 秘密秘密 受控標(biāo)識(shí)受控標(biāo)識(shí) 第第 1 冊(cè)冊(cè) 共共 7 頁(yè)頁(yè) 共共 1 冊(cè)冊(cè) 版版 本本 狀態(tài)狀態(tài)擬制擬制審核審核批準(zhǔn)批準(zhǔn)批準(zhǔn)日期批準(zhǔn)日期修訂信息修訂信息 A 相關(guān)部門 人員會(huì)簽 接收文件的部門或人員 文 件 發(fā) 放 2 替換舊版文件 替換 1 文件修訂頁(yè)文件修訂頁(yè) 編 號(hào) 章節(jié) 名稱 修訂內(nèi)容簡(jiǎn)述 修訂 日期 訂前 版本 訂后 版本 修訂人批準(zhǔn)人 1 2 1 目目錄錄 1 范圍范圍 1 1 1 系統(tǒng)概述 1 1 2 文檔概述 1 1 3 術(shù)語與縮略語 1 2 引用文檔引用文檔 1 3 接口設(shè)計(jì)接口設(shè)計(jì) 1 3 1 外部接口 1 3 2 用戶接口 2 3 3 內(nèi)部接口 2 1 1 范圍范圍 1 1 系統(tǒng)概述系統(tǒng)概述 描述軟件系統(tǒng)的運(yùn)行環(huán)境 主要用途 描述軟件系統(tǒng)的總體功能 構(gòu)成 子系統(tǒng)構(gòu)成 使得讀者對(duì)系統(tǒng)有一個(gè)總體的概要的了解 讀者看完系統(tǒng)概述知道了這個(gè)軟件是做什么用的 主要的功能是什么 用在什么樣的 場(chǎng)合 這樣讀者就可以對(duì)系統(tǒng)有一個(gè)整體的了解 1 2 術(shù)語與縮略語術(shù)語與縮略語 本文檔使用的術(shù)語與縮略語 本文檔使用的術(shù)語與縮略語 XXXX XXXXXXXXXXXX 2 引用文檔引用文檔 1 XXXXXXX XXXXXXXXXX YYYY 年 MM 月 2 XXXXXXX XXXXXXXXXX YYYY 年 MM 月 3 接口設(shè)計(jì)接口設(shè)計(jì) 3 1 外部接口外部接口 說明該系統(tǒng)同外界的所有接口安排 包軟件接口與硬件接口 例如 通訊接口 直接硬件接口 支撐軟件接口以及與其它軟件模塊間的接口設(shè)計(jì) 1 外部網(wǎng)絡(luò)通訊接口設(shè)計(jì) 外部通訊網(wǎng)絡(luò)接口設(shè)計(jì)是指與本系統(tǒng)范圍外的網(wǎng)絡(luò)接口 如上層管理網(wǎng)等的接口和協(xié) 議 信息流向 信息 長(zhǎng)度和通訊周期等 2 外部串行口通訊接口設(shè)計(jì) 外部串行口通訊接口設(shè)計(jì)是指與本系統(tǒng)范圍外的其它系統(tǒng)采用串行口通訊時(shí)的接口關(guān) 系 包括通訊協(xié)議 握手方式 波特率 校驗(yàn)方式等 信息流向 信息長(zhǎng)度和通訊周期等 還應(yīng)說明當(dāng)通訊過于頻繁或超時(shí)時(shí)的措施 2 3 與各支持軟件的接口設(shè)計(jì) 指本軟件要用到的支持軟件的接口設(shè)計(jì) 如數(shù)據(jù)庫(kù)管理服務(wù)接口 畫面信息庫(kù) 控制 算法 接口設(shè)計(jì)等 4 外部軟件模塊通訊接口設(shè)計(jì) 如果本軟件還要與其它子系統(tǒng)通訊時(shí) 應(yīng)定義本軟件與其它軟件模塊間的接口關(guān)系 包括啟動(dòng) 被啟動(dòng)方式 輸入和輸出信息的介質(zhì)及其格式 5 直接硬件接口設(shè)計(jì) 指本軟件要針對(duì)其直接編程的硬件接口設(shè)計(jì) 如過程 PIO 板等的接口設(shè)計(jì) 專用鍵盤 的編碼設(shè)計(jì)等 3 2 用戶接口用戶接口 例如 用戶接口一般要包括用戶操作過程 人機(jī)會(huì)話 設(shè)計(jì) 顯示畫面設(shè)計(jì)和打印報(bào)表 設(shè)計(jì)等 1 用戶操作過程設(shè)計(jì) 用戶操作過程設(shè)計(jì)一般包括以下內(nèi)容 專用鍵盤定義 如果用到專用鍵盤的話 用戶對(duì)話過程設(shè)計(jì) 包括功能鍵定義 菜單條 屏幕按鈕等設(shè)計(jì) 操作提示和錯(cuò)誤提示信息設(shè)計(jì) 2 顯示畫面設(shè)計(jì) 顯示畫面設(shè)計(jì)包括 屏幕劃分 窗口設(shè)計(jì) 顯示參數(shù)格式 狀態(tài) 顏色定義顯示信息格式 狀態(tài) 顏色定義 3 打印信息接口設(shè)計(jì) 打印信息接口設(shè)計(jì)包括 打印驅(qū)動(dòng)方式 定時(shí) 隨機(jī) 事件驅(qū)動(dòng)等 打印頁(yè)面設(shè)計(jì) 如表頭內(nèi)容 表格行數(shù) 內(nèi)容等 表格打印參數(shù)格式 如長(zhǎng)度 小數(shù)位數(shù)等 信息打印格式 如信息內(nèi)容 變量格式等 3 3 內(nèi)部接口內(nèi)部接口 例如 內(nèi)部接口設(shè)計(jì)包括文件 進(jìn)程或線程之間的通信關(guān)系 含數(shù)據(jù)定義和驅(qū)動(dòng) 1 文件定義 系統(tǒng)中不同任務(wù)之間的文件定義 包括 名稱 如 錯(cuò)誤日志文件 符號(hào) 如 IF ERRLOG 說明 如 用于記錄系統(tǒng)中出錯(cuò)時(shí)報(bào)告的日志詳細(xì) 來源 如 A B C 進(jìn)程 使用 如 操作員 D 進(jìn)程 3 格式 如 結(jié)構(gòu)定義或表格定義 說明類型和精度和取值范圍 備注 如 正文文件 按行存儲(chǔ) 存儲(chǔ)在共享目錄 share 中 2 數(shù)據(jù)接口 系統(tǒng)中進(jìn)程或線程之間的通信關(guān)系 包括 名稱 如 接收數(shù)據(jù) 符號(hào) 如 ID RECDATA 說明 如 用于傳遞接收數(shù)據(jù) 來源 如 A 進(jìn)程 使用 如 B 進(jìn)程 格式 如 INT 備注 如 數(shù)據(jù)測(cè)量單位 s 秒 m 米 kHz 千赫 值域 若為常數(shù) 則提供 實(shí)際值 標(biāo)識(shí)數(shù)據(jù)元素所需的精度 3 驅(qū)動(dòng)信號(hào) 系統(tǒng)中進(jìn)程或線程之間的驅(qū)動(dòng)關(guān)系 包括 名稱 如 發(fā)送數(shù)據(jù)信號(hào) 符號(hào) 如 IM SENDINFO 說明 如 用于通知發(fā)送進(jìn)程發(fā)送數(shù)據(jù) 來源 如 進(jìn)程組織好數(shù)據(jù)后置 使用 如 B 進(jìn)程收到這個(gè)信號(hào)后讀取 XXXX 緩沖區(qū)發(fā)送數(shù)據(jù) 之后清除 定義 如 電文格式 備注 如 信號(hào)燈 為 1 表示有數(shù)據(jù) 為 0 表示沒有數(shù)據(jù) 推薦用表格的形式定義這