軟件開發(fā)文檔模板GF_接口設(shè)計(jì)說明書

1、.wd.wd.wd.文檔標(biāo)識及版本號 ： DOCPROPERTY 文檔標(biāo)識及版本號 XX工程標(biāo)識.IDD V1.0密級： DOCPROPERTY 密級 秘密* DOCPROPERTY 保密年限 5年編制/修訂日期 ： yyyy-mm-dd DOCPROPERTY 文檔分類 標(biāo)準(zhǔn)性文檔名稱 ： DOCPROPERTY 工程名稱 XX工程中文名稱- DOCPROPERTY 文檔類別 接口設(shè)計(jì)說明 DOCPROPERTY 文檔類別 接口設(shè)計(jì)說明? DOCPROPERTY 工程名稱 XX工程中文名稱? DOCPROPERTY 文檔類別 接口設(shè)計(jì)說明 DOCPROPERTY 文檔類別(英) Interf

2、ace Design Description of DOCPROPERTY 工程名稱(英) XX工程英文名稱編制單位 ： DOCPROPERTY 編制單位 江蘇科技大學(xué)新技術(shù)研究所編 寫 ： DOCPROPERTY 編寫 CNISILS工程組XXX審 核 ： DOCPROPERTY 審核 * MERGEFORMAT YYY批 準(zhǔn) ： DOCPROPERTY 批準(zhǔn) * MERGEFORMAT ZZZ編寫記錄序號編寫時間編寫說明編寫章節(jié)及內(nèi)容概要編寫人修改記錄序號修改時間修改說明修改章節(jié)及內(nèi)容概要修改人目錄 TOC o 1-4 h z u HYPERLINK l _Toc3169931311 范圍

3、 PAGEREF _Toc316993131 h 1HYPERLINK l _Toc3169931321.1 標(biāo)識 PAGEREF _Toc316993132 h 1HYPERLINK l _Toc3169931331.2 系統(tǒng)概述 PAGEREF _Toc316993133 h 1HYPERLINK l _Toc3169931341.3 文檔概述 PAGEREF _Toc316993134 h 1HYPERLINK l _Toc3169931352 引用文檔 PAGEREF _Toc316993135 h 1HYPERLINK l _Toc3169931363 接口設(shè)計(jì) PAGEREF _T

4、oc316993136 h 2HYPERLINK l _Toc3169931373.1 接口標(biāo)識和接口圖 PAGEREF _Toc316993137 h 2HYPERLINK l _Toc3169931383.2 (接口的工程唯一的標(biāo)識符)【原標(biāo)準(zhǔn)中此處編號為3.X，為后續(xù)使用方便，故用自動編號】 PAGEREF _Toc316993138 h 2HYPERLINK l _Toc3169931394 需求的可追蹤性 PAGEREF _Toc316993139 h 4HYPERLINK l _Toc3169931405 注釋 PAGEREF _Toc316993140 h 4文檔模板使用和裁剪說

5、明使用本文檔模板時，首先另存為“，然后通過Word的“文檔屬性來設(shè)置文檔屬性，包括：文檔標(biāo)識及版本號、密級及保密期限、文檔名稱、文檔類別(中、英文)、工程名稱中、英文、編制單位、編寫人、審批人、批準(zhǔn)人等。具體操作方法：Word標(biāo)題欄的Office按鈕菜單準(zhǔn)備屬性文檔屬性高級屬性自定義在“屬性列表中，選擇屬性的“名稱，在“取值框輸入要設(shè)定的值，然后按“更改按鈕。文檔屬性設(shè)置完成后，選中全部文檔內(nèi)容，執(zhí)行右鍵菜單“更新域操作文檔中的所有文檔屬性參數(shù)引用均被替換為最新設(shè)定的取值雙擊任意內(nèi)容頁面的頁眉區(qū)，選中全部頁眉內(nèi)容，執(zhí)行右鍵菜單“更新域操作頁眉中的所有參數(shù)引用均被替換為最新設(shè)定的取值。本文檔模板

6、依據(jù)?GJB 438B-2009 軍用軟件開發(fā)文檔通用要求?制定，模板中的文檔編寫說明均引自?GJB 438B-2009 軍用軟件開發(fā)文檔通用要求?，并用方括號“【和“】括起來，以及使用藍(lán)色文字區(qū)分，主要用于指導(dǎo)文檔的編寫，應(yīng)在文檔編寫完成后或正式提交前予以刪除包括刪除本說明。文檔編寫者可根據(jù)實(shí)際需要，對文檔內(nèi)容進(jìn)展裁剪。按照文檔標(biāo)題順序與本標(biāo)準(zhǔn)模板規(guī)定的標(biāo)題順序一樣的原那么，假設(shè)裁剪了某章或某條，那么在被裁去章條的標(biāo)題下標(biāo)識為“本章假設(shè)無內(nèi)容，那么標(biāo)識為“本章無內(nèi)容，并說明理由?；颉氨緱l假設(shè)無內(nèi)容，那么標(biāo)識為“本條無內(nèi)容，并說明理由。，并說明理由。假設(shè)裁剪的是整章條包括其所有小條，那么僅需在

7、最高層章條的標(biāo)題下標(biāo)識為“本章假設(shè)無內(nèi)容，那么標(biāo)識為“本章無內(nèi)容，并說明理由?；颉氨緱l假設(shè)無內(nèi)容，那么標(biāo)識為“本條無內(nèi)容，并說明理由。，并說明理由。范圍標(biāo)識【本條應(yīng)描述本文檔所適用的系統(tǒng)、接口實(shí)體和接口的完整標(biāo)識，適用時，包括其標(biāo)識號、名稱、縮略名、版本號和發(fā)布號?！勘?-1 本文檔所適用的系統(tǒng)、接口實(shí)體和接口序號名 稱縮略名標(biāo)識號版本號發(fā)布號系統(tǒng)概述【本條應(yīng)概述本文檔所適用的系統(tǒng)和軟件的用途，還應(yīng)描述系統(tǒng)與軟件的一般特性；概述系統(tǒng)開發(fā)、運(yùn)行和維護(hù)的歷史；標(biāo)識工程的需方、用戶、開發(fā)方和保障機(jī)構(gòu)等；標(biāo)識當(dāng)前和方案的運(yùn)行現(xiàn)場；列出其他有關(guān)文檔?！勘緱l假設(shè)無內(nèi)容，那么標(biāo)識為“本條無內(nèi)容，并說明理由。

8、文檔概述【本條應(yīng)概述本文檔的用途和內(nèi)容，并描述與它的使用有關(guān)的保密性方面的要求?！勘緱l假設(shè)無內(nèi)容，那么標(biāo)識為“本條無內(nèi)容，并說明理由。引用文檔【本章應(yīng)列出引用文檔的編號、標(biāo)題、編寫單位、修訂版及日期，還應(yīng)標(biāo)識不能通過正常采購活動得到的文檔的來源。】本章假設(shè)無內(nèi)容，那么標(biāo)識為“本章無內(nèi)容，并說明理由。接口設(shè)計(jì)接口標(biāo)識和接口圖【對于1.1中所標(biāo)識的每個接口，本條應(yīng)描述賦予該接口的工程唯一的標(biāo)識符，適當(dāng)時應(yīng)使用名稱、編號、版本和文檔引用等標(biāo)識接口實(shí)體(系統(tǒng)、配置項(xiàng)、用戶等)。該標(biāo)識應(yīng)說明哪些實(shí)體具有固定的接口特性(要給出這些接口實(shí)體的接口需求)，哪些實(shí)體正被開發(fā)或修改(這些實(shí)體已有各自的接口需求)。

9、適當(dāng)時，可使用一個或多個接口圖來描述這些接口?！勘緱l假設(shè)無內(nèi)容，那么標(biāo)識為“本條無內(nèi)容，并說明理由。(接口的工程唯一的標(biāo)識符)【原標(biāo)準(zhǔn)中此處編號為3.X，為后續(xù)使用方便，故用自動編號】【本條(從32開場編號)應(yīng)通過工程唯一的標(biāo)識符標(biāo)識接口，應(yīng)簡要標(biāo)識接口實(shí)體，并且應(yīng)根據(jù)需要分條描述接口實(shí)體的單方或雙方的接口特性。如果一指定的接口實(shí)體沒有在IDD中提及(例如，一個外部系統(tǒng))，而在本文檔描述接口實(shí)體時需要提到其接口特征，那么這些特征應(yīng)作為假設(shè)予以陳述、或以“當(dāng)未涵蓋的實(shí)體這樣做時，所指定的實(shí)體將的形式描述。本條可引用其他文檔(例如，數(shù)據(jù)字典、協(xié)議標(biāo)準(zhǔn)、用戶接口標(biāo)準(zhǔn))代替本條的描述信息。假設(shè)適用，本

10、設(shè)計(jì)說明應(yīng)包括以下內(nèi)容，可以任何適合于該信息的順序提供，并應(yīng)從接口實(shí)體角度，說明這些特性之間的區(qū)別(例如關(guān)于數(shù)據(jù)元素的大小、頻率或其他特性的不同期望值)。接口實(shí)體分配給接口的優(yōu)先級別。要實(shí)現(xiàn)的接口的類型(如：實(shí)時數(shù)據(jù)傳送、數(shù)據(jù)的存儲和檢索等)。接口實(shí)體應(yīng)提供、存儲、發(fā)送、訪問、接收的各個數(shù)據(jù)元素的特征，如：名稱標(biāo)識符：工程唯一的標(biāo)識符；非技術(shù)(自然語言)名稱；數(shù)據(jù)元素名稱；技術(shù)名稱(如代碼或數(shù)據(jù)庫中的變量或字段名)；縮寫名或同義名。數(shù)據(jù)類型(字母、數(shù)字、整數(shù)等)。大小和格式(如：字符串的長度和標(biāo)點(diǎn)符號)。計(jì)量單位(如：m)?？赡苤档姆秶蛎杜e(如：O99)。準(zhǔn)確度(正確程度)和精度(有效數(shù)字位

11、數(shù))。優(yōu)先級別、時序、頻率、容量、序列、其他的約束條件，如：數(shù)據(jù)元素是否可被更新、業(yè)務(wù)規(guī)那么是否適用。保密性約束。來源(設(shè)置/發(fā)送實(shí)體)和接收者(使用/接收實(shí)體)。接口實(shí)體應(yīng)提供、存儲、發(fā)送、訪問、接收的數(shù)據(jù)元素組合體(記錄、消息、文件、顯示、報(bào)表等)的特征，如：名稱/標(biāo)識符：工程唯一的標(biāo)識符；非技術(shù)(自然語言)名稱；技術(shù)名稱(如代碼或數(shù)據(jù)庫中的記錄或數(shù)據(jù)構(gòu)造)；縮寫名或同義名。數(shù)據(jù)元素集合體中的數(shù)據(jù)元素及其構(gòu)造(編號、次序、分組)。媒體(如盤)和媒體中數(shù)據(jù)元素/數(shù)據(jù)元素集合體的構(gòu)造。顯示和其他輸出的視聽特性(如：顏色、布局、字體、圖標(biāo)和其他顯示元素、蜂鳴聲、亮度等)。數(shù)據(jù)元素集合體之間的關(guān)系

12、，如排序/訪問特性。優(yōu)先級別、時序、頻率、容量、序列、其他的約束條件，如：數(shù)據(jù)元素集合體是否可被修改、業(yè)務(wù)規(guī)那么是否適用。保密性約束。來源(設(shè)置發(fā)送實(shí)體)和接收者(使用/接收實(shí)體)。接口實(shí)體將為接口使用的通信方法的特征。如：工程唯一的標(biāo)識符；通信鏈接/帶寬/頻率/媒體及其特性；消息格式化；流控制(如：序列編號和緩沖區(qū)分配)：數(shù)據(jù)傳送速率，周期性/非周期性，傳輸間隔；路由、尋址、命名約定；傳輸服務(wù)，包括優(yōu)先級別和等級；安全性/保密性方面的考慮，如：加密、用戶鑒別、隔離、審核等。接口實(shí)體將為接口使用的協(xié)議的特征，如：工程唯一的標(biāo)識符；協(xié)議的優(yōu)先級別/層次；打包，包括分段和重組、路由、尋址；合法性檢查、錯誤控制和恢復(fù)過程；同步，包括連接的建設(shè)、維護(hù)、終止；狀態(tài)、標(biāo)識、任何其他報(bào)告特征。 其他特征，如：接口實(shí)體的物理兼容性(尺寸、公差、負(fù)荷、電壓和接插件兼容性等)?！勘緱l假設(shè)無內(nèi)容，那么標(biāo)識為