軟件開發(fā)文檔模板GF接口需求規(guī)格說明

1、文檔標(biāo)識及版本號:XX項目標(biāo)識.IRS密級：秘密求5年編制/修訂日期：yyyy-nnrdd規(guī)范性文檔名稱：XX項目中文名稱-接口需求規(guī)格說明接口需求規(guī)格說明XX項目中文名稱接口需求規(guī)格說明InterfaceRequirementSpecificationofXX項目英文名稱編制單位:江蘇科技大學(xué)新技術(shù)研究所編寫：CNISILS項目組XXX審核：YYY批準(zhǔn)：ZZZ編寫記錄序號編寫時間編寫說明（編寫章節(jié)及內(nèi)容概要）編寫人1.2.3.4.5.6.7.8.9.10.修改記錄序號修改時間修改說明（修改章節(jié)及內(nèi)容概要）修改人1.2.3.4.5.6.7.8.9.10.范圍錯誤!未定義書簽。標(biāo)識錯誤!未定義書

2、簽。系統(tǒng)概述錯誤!未定義書簽。文檔概述錯誤!未定義書簽。2引用文檔錯誤!未定義書簽。3需求錯誤!未定義書簽。接口標(biāo)識和接口圖錯誤!未定義書簽。（接口的項目唯標(biāo)識符【原標(biāo)準(zhǔn)中此處編號為，為后續(xù)利用方便，故用自動編號】錯誤!未定義書簽。需求的優(yōu)先順序和關(guān)鍵性【原標(biāo)準(zhǔn)中此處編號為，為后續(xù)利用方便，故用自動編號】錯誤!未定義書簽。4合格性規(guī)定錯誤!未定義書簽。5需求可追蹤性.6注釋.錯誤!未定義書簽。.錯誤!未定義書簽。文檔模板利用和裁剪說明利用本文檔模板時，第一另存為“實際文檔名”，然后通過Word的“文檔屬性”來設(shè)置文檔屬性，包括：文檔標(biāo)識及版本號、密級及保密期限、文檔名稱、文檔類別（中、英文）、

3、項目名稱（中、英文）、編制單位、編寫人、審批人、批準(zhǔn)人等。具體操作方式：Word題目欄的Office按鈕菜單預(yù)備屬性文檔屬性高級屬性自概念在“屬性”列表中，選擇屬性的“名稱”，在“取值”框輸入要設(shè)定的值，然后按“更改”按鈕。文檔屬性設(shè)置完成后，選中全數(shù)文檔內(nèi)容，執(zhí)行右鍵菜單“更新域”操作（文檔中的所有文檔屬性參數(shù)引用均被替換為最新設(shè)定的取值）雙擊任意內(nèi)容頁面的頁眉區(qū)，選中全數(shù)頁眉內(nèi)容，執(zhí)行右鍵菜單“更新域”操作（頁眉中的所有參數(shù)引用均被替換為最新設(shè)定的取值）。本文檔模板依據(jù)GJB438B-2020軍用軟件開發(fā)文檔通用要求制定，模板中的文檔編寫說明均引自GJB438B-2020軍用軟件開發(fā)文檔通

4、用要求，并用方括號和括起來，和利用藍(lán)色文字區(qū)分，要緊用于指導(dǎo)文檔的編寫，應(yīng)在文檔編寫完成后或正式提交前予以刪除（包括刪除本說明）。文檔編寫者可依如實際需要，對文檔內(nèi)容進(jìn)行裁剪。依照文檔題目順序與本標(biāo)準(zhǔn)模板規(guī)定的題目順序相同的原那么，假設(shè)裁剪了某章或某條，那么在被裁去章條的題目下標(biāo)識為“本章假設(shè)無內(nèi)容，那么標(biāo)識為“本章無內(nèi)容”，并說明理由?！被颉氨緱l假設(shè)無內(nèi)容，那么標(biāo)識為“本條無內(nèi)容”，并說明理由?！?，并說明理由。假設(shè)裁剪的是整章條（包括其所有小條），那么僅需在最高層章條的題目下標(biāo)識為“本章假設(shè)無內(nèi)容，那么標(biāo)識為“本章無內(nèi)容”，并說明理由?！被颉氨緱l假設(shè)無內(nèi)容，那么標(biāo)識為“本條無內(nèi)容”，并說明理

5、由。”，并說明理由。2引用文檔1范圍1.1 標(biāo)識【本條應(yīng)包括本文檔適用系統(tǒng)、接話柄體和接口的完全標(biāo)識，適歷時.，包括其標(biāo)識號、名稱、縮略名、版本號和發(fā)布號?！勘肀疚臋n所適用的系統(tǒng)、接口實體和接口序號名稱縮略名標(biāo)識號版本號發(fā)布號1.2.3.4.5.6.7.8.1.2 系統(tǒng)概述【本條應(yīng)概述本文檔所適用的系統(tǒng)和軟件的用途，還應(yīng)描述系統(tǒng)與軟件的一樣特性；概述系統(tǒng)開發(fā)、運行和保護(hù)的歷史；標(biāo)識項目的需方、用戶、開發(fā)方和保障機構(gòu)等；標(biāo)識當(dāng)前和打算的運行現(xiàn)場；列出其他有關(guān)文檔。】（本條假設(shè)無內(nèi)容，那么標(biāo)識為“本條無內(nèi)容”，并說明理由。）1.3 文檔概述【本條應(yīng)概述本文檔的用途和內(nèi)容，并描述與它的利用有關(guān)的保密

6、性方面的要求?！浚ū緱l假設(shè)無內(nèi)容，那么標(biāo)識為“本條無內(nèi)容”，并說明理由。）【本章應(yīng)列出引用文檔的編號、題目、編寫單位、修訂版及日期，還應(yīng)標(biāo)識不能通過正常采購活動取得的文檔的來源。1（本章假設(shè)無內(nèi)容，那么標(biāo)識為“本章無內(nèi)容”，并說明理由。）3需求3.1 接口標(biāo)識和接口圖【關(guān)于中標(biāo)識的每一個接口，本條應(yīng)包括其項目唯一的標(biāo)識符，（假設(shè)適用）應(yīng)通過名稱、編號、版本和文檔引用來指明接話柄體（系統(tǒng)、配置項、用戶等）。該標(biāo)識應(yīng)聲明哪些實體具有固定的接口特性（要給出這些接話柄體的接口需求），說明哪些實體正在開發(fā)或修改當(dāng)中（這些實體已有各自的接口需求）。可通過一張或多張接口圖來描述這些接口C】（本條假設(shè)無內(nèi)容，

7、那么標(biāo)識為“本條無內(nèi)容”，并說明理由。）3.2 （接口的項目唯一標(biāo)識符）【原標(biāo)準(zhǔn)中此處編號為，為后續(xù)利用方便，故用自動編號】【本條（從開始編號）應(yīng)通過項目唯一的標(biāo)識符來標(biāo)識接口，并簡腹地標(biāo)識接話柄體。依照需要可分條描述為實現(xiàn)該接口而提出的一個或多個接話柄體的需求。若是一個實體的接口特性未包括在本文檔中，可是描述對該接話柄體的需求時需要提到其接口特性，這些特性應(yīng)作為假定予以陳述，或以“當(dāng)未涵蓋的實體這么做時，所指定的實體將”的形式描述，而不作為本文檔沒有涵蓋的實體的需求。本條可引用其它文檔（例如數(shù)據(jù)字典、通信協(xié)議標(biāo)準(zhǔn)、用戶接口標(biāo)準(zhǔn)）代替在此所描述的信息。假設(shè)適用，需求應(yīng)包括如下內(nèi)容，并以適合于需

8、求的任何順序給出，還應(yīng)從接話柄體的角度說明這些特性之間的區(qū)別（例如關(guān)于數(shù)據(jù)元素的大小、頻率或其它特性的不同期望值）。a）接話柄體必需分派給該接口的優(yōu)先級。b）關(guān)于要實現(xiàn)的接口類型的需求（例如實時數(shù)據(jù)傳送、數(shù)據(jù)的存儲和檢索等）c）接話柄體必需提供、存儲、發(fā)送、存取、接收的各個數(shù)據(jù)元素所要求的特點,例如：1）名稱/標(biāo)識符：a.項目唯一標(biāo)識符；b.非技術(shù)（自然語言）名稱；c.數(shù)據(jù)元素名稱；d.技術(shù)名稱（如在代碼或數(shù)據(jù)庫中的變量名或字段名）：e.縮略名或同義名；2）數(shù)據(jù)類型（字母、數(shù)字、整數(shù)等）；3）大小和格式（如：字符串的長度和標(biāo)點符號）；4）計量單位（如m）；5）可能值的范圍或列舉（如：099）；

9、6）準(zhǔn)確性（正確程度）和精度（有效數(shù)字位數(shù)）；7）優(yōu)先級別、時序、頻率、容量、序列和其它的約束條件（例如數(shù)據(jù)元素是不是能夠被更新、業(yè)務(wù)規(guī)那么是不是適用）。8）保密性約束；9）來源（成立/發(fā)送的實體）和接收者（利用/接收的實體）；d）接話柄體必需提供、存儲、發(fā)送、訪問、接收的數(shù)據(jù)元素組合體（記錄、消息、文件、數(shù)組、顯示、報表等）所要求的特點，例如：1）名稱/標(biāo)識符：a.項目唯一標(biāo)識符；b.非技術(shù)（自然語言）名稱；c.技術(shù)名稱（如在代碼或數(shù)據(jù)庫中的記錄名或數(shù)據(jù)結(jié)構(gòu)名）；d.縮寫名或同義名。2）包中的數(shù)據(jù)元素及其結(jié)構(gòu)（編號、順序和成組情形）；3）介質(zhì)（例如磁盤）和在介質(zhì)上數(shù)據(jù)元素/包的結(jié)構(gòu)；4）顯示

10、和其它輸出的視聽特性（例如顏色、布局、字體、圖標(biāo)和其它顯示元素、蜂鳴聲和亮度）；5）包之間的關(guān)系，如排序/存取特性；6）優(yōu)先級、按時、頻率、容量、定序及其它約束，例如包是不是能夠被更新、業(yè)務(wù)規(guī)那么是不是適用；7）保密性約束；8）來源（成立/發(fā)送的實體）和接收者（利用/接收的實體）。e）接話柄體必需利用的接口的通信方式所要求的特點。如：1）項目唯一標(biāo)識符；2）通信鏈接/帶寬/頻率/介質(zhì)及其特性；3）消息格式；4）流操縱（如：序列編號緩和沖區(qū)分派）；5）周期性/非周期傳送的數(shù)據(jù)傳送速度，傳輸距離；6）路由、尋址、命名約定；7）傳輸效勞，包括：優(yōu)先權(quán)和品級；8）平安性/保密性考慮，如：加密、用戶辨別

11、、隔離和審核。f）接話柄體必需利用的接口的協(xié)議所要求的特點，如：1）項目唯一標(biāo)識符；2）協(xié)議的優(yōu)先級別/層次；3）打包，包括拆包和從頭打包、路由和尋址；4）合法性檢查、錯誤操縱和恢復(fù)進(jìn)程；5）同步，包括成立連接、維持和終止；6）狀態(tài)、標(biāo)識及任何其它報告的特性。g）其它所要求的特特點，例如接話柄體的物理兼容性（尺寸、公差、負(fù)載、和接插件的兼容性等）、電壓等,】（本條假設(shè)無內(nèi)容，那么標(biāo)識為“本條無內(nèi)容”，并說明理由。）3.3需求的優(yōu)先順序和關(guān)鍵性【原標(biāo)準(zhǔn)中此處編號為，為后續(xù)利用方便，故用自動編號】【（假設(shè)適用）本條應(yīng)描述本文檔中各需求的優(yōu)先順序、關(guān)鍵性或所給予的指示其相對重要性的權(quán)重。例如標(biāo)識對平

12、安性或保密性關(guān)鍵的需求，以便進(jìn)行特殊處置。若是所有需求具有相等的權(quán)重，本條應(yīng)如實說明?！浚ū緱l假設(shè)無內(nèi)容，那么標(biāo)識為“本條無內(nèi)容”，并說明理由。）4合格性規(guī)定【本條應(yīng)概念一組合格性方式，并為第3章中每一個需求指定為確保需求取得知足所應(yīng)利用的方式。可用表格形式表述該信息，或為第3章的每一個需求注明所利用的方式。合格性方式能夠包括：a）演示：依托可見的功能操作，直接運行接話柄體，而不需要利用儀器、專用測試設(shè)備或進(jìn)行事后分析；b）測試：利用儀器或?qū)Ｓ脺y試設(shè)備，運行接話柄體，以便搜集數(shù)據(jù)供事后分析利用；c）分析：處置從其它合格性方式中取得的積存數(shù)據(jù)。例如，對測試結(jié)果進(jìn)行簡約、說明或推斷。d）審查：對接

13、話柄體、文檔等進(jìn)行目視檢查；e）特殊的合格性方式：任何針對接話柄體的特殊合格性方式，例如專用工具、技術(shù)、規(guī)程、設(shè)施、驗收限制?！浚ū緱l假設(shè)無內(nèi)容，那么標(biāo)識為“本條無內(nèi)容”，并說明理由。）5需求可追蹤性【對系統(tǒng)級接話柄體，本章不適用。對每一個子系統(tǒng)級或更低級的接話柄體，本章應(yīng)包括：a）從本規(guī)格說明中實體的每一個需求，到該需求所涉及的系統(tǒng)（或子系統(tǒng)）需求的可追蹤性。（也能夠通過對第3章中的每一個需求進(jìn)行注釋來提供可追蹤性）。注：每一個層次的系統(tǒng)細(xì)化都可能致使不能直接追蹤到較高層次需求的需求。例如：創(chuàng)建多個CSCI的系統(tǒng)體系結(jié)構(gòu)設(shè)計可能導(dǎo)出關(guān)于這些CSCI如何接口的需求，而這些接口需求在系統(tǒng)需求中并無涵蓋。如此的需求能