GJB438B軍用軟件開發(fā)文檔通用要求

GJB438B概述GJB438B課題組2010.07GJB438B軍用軟件開發(fā)文檔通用要求提綱背景全貌適用范圍一般要求詳細要求GJB438B軍用軟件開發(fā)文檔通用要求修訂背景隨著裝備信息化迅速發(fā)展，裝備中計算機軟件的種類、規(guī)模、以及安全、保密等屬性的要求都迅速增加或提高。實踐中許多軍用軟件開發(fā)者感到GJB2786《武器系統(tǒng)軟件開發(fā)》存在一些問題，如：比較適合于采用結(jié)構(gòu)化軟件開發(fā)方法和瀑布式開發(fā)模型，缺乏靈活性；對于大型信息系統(tǒng)的軟件開發(fā)缺少有關規(guī)定（如：對于需求逐步明確的情況、數(shù)據(jù)庫設計和實現(xiàn)）；對上個世紀九十年代以后廣泛采用的軟件工程有關要求、技術和方法未明確涉及，如軟件開發(fā)策劃和跟蹤、測量和分析、質(zhì)量保證、軟件重用等。軟件質(zhì)量管理規(guī)定和GJB5000的貫徹實施，促使軍用軟件有關各方對軟件工程化和軟件過程改進的認識有很大提高。同時，也感到GJB2786在有些方面還沒有明確支持，或不夠協(xié)調(diào)。GJB438B軍用軟件開發(fā)文檔通用要求修訂背景（續(xù)1）軟件文檔是整個軟件開發(fā)工作的重要產(chǎn)品，是實行管理、監(jiān)督、控制軟件開發(fā)的重要的方式。軟件文檔把軟件開發(fā)過程中的一些不可見的事物轉(zhuǎn)化成為可見的文字資料，便于管理人員在各個階段檢查開發(fā)計劃的進展情況，以提高軟件生產(chǎn)過程的可見性和可控性。軟件文檔作為軟件產(chǎn)品的一部分，文檔的質(zhì)量在很大程度上決定了軟件的質(zhì)量。軟件的種類、文檔的多少、文檔的內(nèi)容要求，對軟件開發(fā)效率、開發(fā)成本以及將來的維護都產(chǎn)生重要的影響。在軟件開發(fā)中不論是軟件承制方還是軟件訂購方對文檔都極為重視。GJB438B軍用軟件開發(fā)文檔通用要求修訂背景（續(xù)2）

GJB2786A《軍用軟件開發(fā)通用要求》在修訂過程中，主要以MIL-STD-498“軟件開發(fā)與文檔編制”的框架為參考，并增加相關的軟件工程實踐。因此，與之配套的文檔類型、內(nèi)容和形式上都要相應發(fā)生變化。需要對GJB438A進行修訂，保留其有效方面，改進其不足之處，以適應當前我軍裝備軟件研制的需要。GJB438B軍用軟件開發(fā)文檔通用要求GJB438B更名原因

本標準是與GJB2786A（修訂中）配套使用GJB2786在修訂過程中，專家建議將名稱改為《軍用軟件開發(fā)通用要求》本標準修訂時也將名稱作了相應變化，改為《軍用軟件開發(fā)文檔通用要求》。GJB438B軍用軟件開發(fā)文檔通用要求概貌第1章范圍第2章引用文件第3章術語、定義和縮略語第4章一般要求第5章詳細要求附錄28個附錄GJB438B軍用軟件開發(fā)文檔通用要求適用范圍在GJB438B范圍一節(jié)中明確指出：本標準規(guī)定了軍用軟件開發(fā)文檔編制的種類、結(jié)構(gòu)、格式和內(nèi)容等要求。本標準適用于軍用軟件開發(fā)過程中文檔的編制。而在GJB2786A的范圍一節(jié)中指出，該標準規(guī)定了軍用軟件開發(fā)的通用要求，包括軟件開發(fā)過程的開發(fā)、支持和管理等方面的要求。本標準適用于需方和開發(fā)方獲取、開發(fā)及維護軍用軟件（含固件中的軟件）。GJB438B軍用軟件開發(fā)文檔通用要求適用范圍（續(xù)1）本標準中所涉及的“系統(tǒng)”有兩類：

一類是硬件－軟件系統(tǒng)（例如一個雷達系統(tǒng)），對于這種系統(tǒng)，本標準只適用于系統(tǒng)中的軟件部分；另一類是軟件系統(tǒng)（例如一個地理信息系統(tǒng)），對這類系統(tǒng)，本標準適用于其整個系統(tǒng)。本標準規(guī)定了執(zhí)行GJB2786A所產(chǎn)生的軍用軟件開發(fā)文檔，適用于軍用軟件開發(fā)過程中文檔的編制。GJB438B軍用軟件開發(fā)文檔通用要求GJB438B其他說明本標準代替GJB438A-1997。與GJB438A-1997相比，本次修訂將標準的名稱更改為《軍用軟件開發(fā)文檔通用要求》。依據(jù)GJB2786A，從軟件開發(fā)和管理的角度，規(guī)定了相應的文檔編制要求?？紤]承研單位的實際要求，對測試計劃的部分內(nèi)容也進行了充實和調(diào)整。GJB438B軍用軟件開發(fā)文檔通用要求文檔編制

文檔的內(nèi)容是根據(jù)GJB2786A各活動描述的工作任務而產(chǎn)生的，描述了軍用軟件開發(fā)過程中的主要活動信息和要求。開發(fā)方應按照本標準的要求記錄有關信息，編寫有關文檔，并按合同（或軟件研制任務書）的要求交付。文檔若為電子文檔，應規(guī)定電子文檔的格式（如DOC文件、PDF文件等）。GJB438B軍用軟件開發(fā)文檔通用要求軟件開發(fā)活動分類基本活動類（18個）系統(tǒng)需求分析系統(tǒng)設計系統(tǒng)集成與測試系統(tǒng)合格性測試軟件需求分析軟件設計軟件實現(xiàn)與單元測試單元集成與測試CSCI合格性測試軟件驗收支持支持活動類（6個）軟件使用準備軟件移交準備軟件配置管理軟件工作產(chǎn)品評價軟件質(zhì)量保證糾正措施聯(lián)合評審測量與分析組織活動類（2個）項目策劃和監(jiān)控風險管理分承制方管理與IV&V機構(gòu)聯(lián)系與相關開發(fā)方協(xié)調(diào)保密性有關活動軟件開發(fā)環(huán)境建立項目過程的改進GJB438B軍用軟件開發(fā)文檔通用要求文檔表示方式表示形式：為使各文檔章條的信息更加清晰可讀，可采用圖、表、矩陣或其它形式的表示方式進行說明。頁碼編制文檔正文的目錄使用小寫羅馬數(shù)字編號；文檔正文和附錄均使用阿拉伯數(shù)字順序編號；若一個文檔分為若干卷，則每一卷應重新開始按順序編號。自變量：字母X和Y為各文檔小條編號的自變量。標題上圓括號中的文字在編寫時要用實際內(nèi)容替換。

GJB438B軍用軟件開發(fā)文檔通用要求文檔結(jié)構(gòu)封面。封面宜包括文檔標識及版本號、密級、編制/修訂日期、文檔名稱、編制單位、編寫、審核、批準。修改頁。修改頁應包括修改時間、修改內(nèi)容以及修改人等。目錄。目錄應包括章、條、圖表、注釋和附錄的編號、標題及其所在頁碼。正文。正文為各文檔的具體內(nèi)容，詳細要求見標準的第5章。附錄。文檔的附錄應提供文檔維護的詳細信息（例如：圖、表、分類數(shù)據(jù)等）。每個附錄都應在文檔的正文中被引用。為方便起見，附錄可單獨裝訂成冊。GJB438B軍用軟件開發(fā)文檔通用要求文檔剪裁承制方可根據(jù)項目所選擇的生存周期、合同（或軟件研制任務書）的要求以及實際活動，確定項目產(chǎn)生的文檔種類，并根據(jù)實際情況對文檔的種類進行合并、拆分。例如，可以在《軟件開發(fā)計劃》中描述了軟件質(zhì)量保證計劃和軟件配置管理計劃的內(nèi)容，也可不產(chǎn)生單獨的《軟件質(zhì)量保證計劃》、《軟件配置管理計劃》。根據(jù)需要，也可以對文檔內(nèi)容進行剪裁。按文檔標題順序與本標準規(guī)定的標題順序相同的原則，若剪裁了某章條或某小條，則在被裁去的章條（或小條）的標題下將其標識為“不適用”，并說明理由。若剪裁的是整章條（包括其所有小條），則僅需在最高層的章條標題下加以說明。GJB438B軍用軟件開發(fā)文檔通用要求詳細要求該標準規(guī)定了對軍用軟件開發(fā)過程中主要活動產(chǎn)生的文檔，指出哪些文檔可以合并或剪裁。下面按照管理和工程兩類簡要說明文檔的概述和主要內(nèi)容。GJB438B軍用軟件開發(fā)文檔通用要求管理類文檔軟件研制任務書（SDTD）軟件開發(fā)計劃（SDP）軟件配置管理計劃（SCMP）軟件質(zhì)量保證計劃（SQAP）軟件安裝計劃（SIP）軟件移交計劃（STrP）軟件測試計劃（STP）軟件配置管理報告（SCMR）軟件質(zhì)量保證報告（SQAR)GJB438B軍用軟件開發(fā)文檔通用要求軟件研制任務書（SDTD）描述軟件開發(fā)的目的、目標、主要任務、功能及性能指標等要求。GJB438B軍用軟件開發(fā)文檔通用要求SDTD的主要內(nèi)容范圍：包括系統(tǒng)和軟件的標識、系統(tǒng)概述和文檔概述等。引用文檔。運行環(huán)境要求：包括硬件環(huán)境和軟件環(huán)境。技術要求：包括軟件的功能、性能、輸入/輸出、數(shù)據(jù)處理要求、接口、固件、關鍵性要求等。設計約束。質(zhì)量控制要求：包括軟件關鍵性等級、標準、文檔、配置管理、測試要求、對分承制方的要求等。驗收和交付。軟件保障要求。進度和里程碑。GJB438B軍用軟件開發(fā)文檔通用要求軟件開發(fā)計劃（SDP）描述實施軟件開發(fā)工作的計劃。軟件開發(fā)活動包含新開發(fā)、修改、重用、再工程、維護和由軟件產(chǎn)品引起的其它所有活動。SDP是動態(tài)的，隨著項目的進展，在出現(xiàn)重大偏差或者在里程碑處應進行分析，必要時重新策劃并修訂SDP。根據(jù)實際需要，可將SDP中的某些部分編制成單獨的計劃，如《軟件配置管理計劃》、《軟件質(zhì)量保證計劃》和《軟件測試計劃》等。GJB438B軍用軟件開發(fā)文檔通用要求SDP的主要內(nèi)容范圍：包括系統(tǒng)和軟件的標識、系統(tǒng)概述、文檔概述等。引用文檔。策劃背景概述。軟件開發(fā)活動的總體實施計劃：包括軟件開發(fā)過程、軟件開發(fā)總體計劃、可重用的軟件產(chǎn)品等。詳細的軟件開發(fā)活動實施計劃。進度表和活動網(wǎng)絡圖。項目組織和資源等。GJB438B軍用軟件開發(fā)文檔通用要求軟件配置管理計劃（SCMP）描述在項目中如何實施軟件配置管理。本計劃既可作為《軟件開發(fā)計劃》的一部分，也可單獨成文。GJB438B軍用軟件開發(fā)文檔通用要求SCMP的主要內(nèi)容范圍：包括系統(tǒng)和軟件的標識、系統(tǒng)概述、文檔概述等；引用文檔；組織和職責：描述軟件配置管理負責人和軟件配置控制委員會的組成以及他們在項目中的職責和權(quán)限；說明與項目配置管理相關人員的職責等；軟件配置管理活動：描述配置標識、配置控制、配置狀態(tài)記錄與報告、配置審核以及軟件發(fā)行管理和交付等五方面的軟件配置管理活動的需求；工具、技術和方法：描述為支持特定項目的軟件配置管理所使用的軟件工具、技術和方法；對供貨單位的控制；進度表等。GJB438B軍用軟件開發(fā)文檔通用要求軟件質(zhì)量保證計劃（SQAP）描述在項目中采用的軟件質(zhì)量保證的措施、方法和步驟。本計劃既可作為《軟件開發(fā)計劃》的一部分，也可單獨成文。GJB438B軍用軟件開發(fā)文檔通用要求SQAP的主要內(nèi)容組織和職責：描述軟件質(zhì)量保證負責人在項目中的職責和權(quán)限；相應的高層經(jīng)理、與軟件質(zhì)量保證緊密配合的項目經(jīng)理的職責；部門內(nèi)部軟件質(zhì)量保證組組長的職責和與項目軟件質(zhì)量保證負責人的關系等。標準、條例和約定：列出軟件開發(fā)過程中要用到的標準、條例和約定，并列出監(jiān)督和保證執(zhí)行的措施?；顒訉徍耍好枋鰧椖炕顒舆M行審核的方法和依據(jù)，并列出項目定義的活動以及相應的活動審核。工作產(chǎn)品審核：描述進行工作產(chǎn)品審核的方法和依據(jù)，列出項目過程應產(chǎn)生的工作產(chǎn)品和質(zhì)量記錄，以及需要由軟件質(zhì)量保證人員負責審核的工作產(chǎn)品和相應的產(chǎn)品審核活動。GJB438B軍用軟件開發(fā)文檔通用要求SQAP的主要內(nèi)容（續(xù)）不符合問題的解決：描述過程評審和產(chǎn)品審核的記錄以及形成記錄的方法，并描述處理在評審和審核中出現(xiàn)的不符合問題的規(guī)程。工具、技術和方法：描述用以支持特定軟件項目質(zhì)量保證工作的工具、技術和方法，描述它們的用途。對供貨單位的控制：描述對軟件銷售單位或軟件承制方法進行控制的規(guī)程。記錄的收集、維護和保存。

GJB438B軍用軟件開發(fā)文檔通用要求軟件安裝計劃（SIP）描述在用戶的現(xiàn)場安裝軟件的計劃，內(nèi)容包括準備工作、用戶培訓以及從現(xiàn)有系統(tǒng)進行轉(zhuǎn)換。當軟件的安裝需要開發(fā)人員參與，且安裝過程十分復雜時，應制定該計劃。GJB438B軍用軟件開發(fā)文檔通用要求SIP的主要內(nèi)容安裝概述：描述安裝過程、安裝地點列表、安裝進度、安裝方法、聯(lián)系地點、保障材料、培訓、軟件安裝過程中所涉及的各項任務、所需人員、保密性方面的考慮等。為軟件中心操作員提供特定現(xiàn)場信息：描述現(xiàn)場安裝期間要完成任務的進度表、軟件清單、設施和食宿供應、安裝小組的、安裝規(guī)程、數(shù)據(jù)更新規(guī)程等。軟件用戶的現(xiàn)場專用信息：描述關于軟件用戶的安裝計劃，內(nèi)容包括安裝期間用戶所完成任務的進度表、安裝規(guī)程、用戶數(shù)據(jù)更新規(guī)程等。GJB438B軍用軟件開發(fā)文檔通用要求軟件移交計劃（STrP）描述開發(fā)方向保障機構(gòu)移交應交付項的計劃。如果在合同或軟件研制任務書中規(guī)定了向獨立保障方移交的責任，應制定STrP。GJB438B軍用軟件開發(fā)文檔通用要求STrP的主要內(nèi)容軟件保障資源：描述支持可交付軟件所需的設施、硬件、軟件及其相關的文檔，描述支持可交付軟件所需的人員及其它資源，并標識各部分軟件保障資源之間的關系。推薦的過程：描述為支持可交付的軟件和相關的保障環(huán)境，開發(fā)方希望向保障機構(gòu)推薦的規(guī)程，包括建議和經(jīng)驗教訓。培訓：描述開發(fā)方關于軟件交付支持人員的培訓計劃。預期的更改區(qū)域：描述可交付軟件預期的更改區(qū)域。移交計劃：描述開發(fā)方把可交付軟件移交給保障機構(gòu)的計劃。GJB438B軍用軟件開發(fā)文檔通用要求軟件測試計劃（STP）描述對計算機軟件配置項（CSCI）和軟件系統(tǒng)或子系統(tǒng)進行合格性測試的計劃。通常每個項目都應有一個STP。需方根據(jù)STP能夠評估CSCI或軟件系統(tǒng)合格性測試的策劃是否充分。GJB438B軍用軟件開發(fā)文檔通用要求STP的主要內(nèi)容測試依據(jù)：列出軟件測試必須遵循的依據(jù)。軟件測試環(huán)境：描述在各測試現(xiàn)場的測試活動所需的軟件項、硬件和固件項等，描述網(wǎng)絡拓撲圖及所需的其它材料，描述與軟件測試環(huán)境中每個元素有關的專有性質(zhì)、需方權(quán)利與許可證等問題，描述開發(fā)方安裝、測試和控制軟件測試環(huán)境中的每一項的計劃，描述擬建立的測試環(huán)境與需求環(huán)境之間的差異，描述參與現(xiàn)場測試的組織及職責、人員及分工，描述測試前和測試期間要進行的人員培訓，標識測試現(xiàn)場要執(zhí)行的測試等。測試標識：描述要執(zhí)行的測試的級別、類別、一般測試條件、測試進展、數(shù)據(jù)記錄整理和分析等一般信息，描述計劃執(zhí)行的測試等。測試進度：描述實施本計劃中所標識測試的進度表。測試終止條件：描述被測軟件的評價準則和方法以及結(jié)束測試的條件。需求的可追蹤性。

GJB438B軍用軟件開發(fā)文檔通用要求軟件配置管理報告（SCMR）描述軟件整個研制/開發(fā)過程中軟件配置管理情況。GJB438B軍用軟件開發(fā)文檔通用要求SCMR的主要內(nèi)容軟件配置管理情況綜述：描述軟件配置管理活動進展，與軟件配置管理計劃的偏差，軟件配置管理活動與規(guī)程是否相符，對不符合項所采取的措施，完成軟件配置管理工作的工作量等；軟件配置管理基本信息：概述軟件配置管理的基本信息；專業(yè)組劃分及權(quán)限分配：列出項目專業(yè)組的劃分、各專業(yè)組的成員以及各成員的權(quán)限分配；配置項記錄：列出項目的所有配置項及配置項版本變更歷史、配置項變更累計次數(shù)等內(nèi)容；變更記錄：列出軟件研制過程中的所有變更；GJB438B軍用軟件開發(fā)文檔通用要求SCMR的主要內(nèi)容（續(xù)）基線記錄：列出項目的所有基線的內(nèi)容及版本號等內(nèi)容；入庫記錄：列出配置項的入庫記錄；出庫記錄：列出配置項的出庫記錄；審核記錄：列出軟件研制過程中所進行的軟件配置審核；備份記錄：列出軟件研制過程中所做的配置庫備份；測量：列出軟件配置管理計劃的版次數(shù)、配置狀態(tài)記錄份數(shù)、軟件入庫單份數(shù)、軟件出庫單份數(shù)、變更申請單份數(shù)、被批準的變更申請單份數(shù)、配置管理報告份數(shù)、配置審核記錄份數(shù)、配置管理員工作量等。GJB438B軍用軟件開發(fā)文檔通用要求軟件質(zhì)量保證報告（SQAR)描述軟件整個研制/開發(fā)過程中軟件質(zhì)量保證情況。GJB438B軍用軟件開發(fā)文檔通用要求SQAR的主要內(nèi)容軟件研制概述：逐項說明軟件研制所經(jīng)歷的各項活動及其完成情況，包括軟件需求分析、軟件設計、軟件實現(xiàn)和軟件測試等；軟件質(zhì)量保證情況：逐項說明在保證軟件質(zhì)量方面所開展的各項工作及其完成情況，包括分析、評審、審查、測試、試驗、軟件質(zhì)量保證、質(zhì)量歸零等；軟件配置管理情況：描述軟件配置管理活動的情況，包括與軟件配置管理計劃的偏差、配置管理活動與規(guī)程是否相符、對不符合項所采取的措施以及軟件配置狀態(tài)變化等；第三方評測情況：描述第三方評測工作情況和質(zhì)量評價結(jié)論。GJB438B軍用軟件開發(fā)文檔通用要求工程類文檔

軟件產(chǎn)品規(guī)格說明（SPS）軟件版本說明（SVD）軟件用戶手冊（SUM）軟件輸入/輸出手冊（SIOM）軟件中心操作員手冊（SCOM）計算機編程手冊（CPM）計算機操作手冊（COM）固件保障手冊（FSM）軟件研制總結(jié)報告（SDSR)運行方案說明（OCD）系統(tǒng)/子系統(tǒng)規(guī)格說明（SSS）接口需求規(guī)格說明（IRS）系統(tǒng)/子系統(tǒng)設計說明（SSDD）接口設計說明（IDD）軟件需求規(guī)格說明（SRS）軟件設計說明（SDD）數(shù)據(jù)庫設計說明（DBDD）軟件測試說明（STD）軟件測試報告（STR）GJB438B軍用軟件開發(fā)文檔通用要求運行方案說明（OCD）描述系統(tǒng)應滿足的用戶需要、與現(xiàn)有系統(tǒng)或規(guī)程的關系以及使用方式等。既可向開發(fā)者表述用戶的需要，也可向用戶或其它對象表達開發(fā)者的思路，以便在需方、開發(fā)方、支持者和用戶代理之間，對所開發(fā)的系統(tǒng)的運行方案達成共識。GJB438B軍用軟件開發(fā)文檔通用要求OCD的主要內(nèi)容現(xiàn)行系統(tǒng)或狀態(tài)：描述現(xiàn)行系統(tǒng)或狀態(tài)的背景、目標和范圍，運行策略和約束，用戶或相關人員和保障方案等，并給出現(xiàn)行系統(tǒng)或狀態(tài)的具體描述。更改理由和實質(zhì)：包括更改理由、所需更改的說明、更改的優(yōu)先級別、考慮但未納入的更改、假設和約束等。新系統(tǒng)或修改后系統(tǒng)的方案：描述新系統(tǒng)或修改后系統(tǒng)的背景、目標和范圍，運行策略和約束，用戶/受影響人員和保障方案等，并給出新系統(tǒng)或修改后系統(tǒng)的具體描述。運行場景：舉例說明新系統(tǒng)或修改后系統(tǒng)的作用。影響綜述：包括運行影響、組織影響、開發(fā)期間的影響等。建議系統(tǒng)分析：包括優(yōu)點概述、缺點/限制概述、考慮的替代方案和權(quán)衡等。GJB438B軍用軟件開發(fā)文檔通用要求系統(tǒng)或子系統(tǒng)規(guī)格說明（SSS）

描述系統(tǒng)的需求，以及確保滿足各需求所使用的方法。系統(tǒng)外部接口方面的相關需求，可在SSS中給出或在引用的一個或多個《接口需求規(guī)格說明》中給出。SSS可由《接口需求規(guī)格說明》補充，共同構(gòu)成系統(tǒng)設計與合格性測試的基礎。GJB438B軍用軟件開發(fā)文檔通用要求SSS的主要內(nèi)容

需求：描述系統(tǒng)要求的狀態(tài)和方式、系統(tǒng)能力需求、系統(tǒng)外部接口需求、系統(tǒng)內(nèi)部接口需求、適應性需求、安全性需求、保密性需求、系統(tǒng)環(huán)境需求、計算機資源需求、系統(tǒng)質(zhì)量因素、設計和構(gòu)造的約束、人員相關需求、培訓相關需求、保障相關需求、包裝需求、需求的優(yōu)先順序和關鍵性等。合格性規(guī)定：描述為確保每個需求得到滿足所定義使用的方法。需求可追蹤性。GJB438B軍用軟件開發(fā)文檔通用要求接口需求規(guī)格說明（IRS）描述作用于一個或多個系統(tǒng)、子系統(tǒng)、硬件配置項（HWCI）、計算機軟件配置項(CSCI)、人工操作或者其它系統(tǒng)部件之間的需求，從而實現(xiàn)這些實體間的一個或多個接口。一個IRS可以包含多個接口。IRS可作為《系統(tǒng)或子系統(tǒng)需求規(guī)格說明》和《軟件需求規(guī)格說明》的補充，共同構(gòu)成系統(tǒng)和CSCI設計與合格性測試的基礎。GJB438B軍用軟件開發(fā)文檔通用要求IRS的主要內(nèi)容需求：包括接口標識和接口圖，描述為實現(xiàn)每個接口而提出一個或多個接口實體的需求，并描述需求的優(yōu)先順序和關鍵性。合格性規(guī)定：描述為確保每個需求得到滿足所定義使用的方法。需求可追蹤性。GJB438B軍用軟件開發(fā)文檔通用要求系統(tǒng)或子系統(tǒng)設計說明（SSDD）

描述系統(tǒng)或子系統(tǒng)的系統(tǒng)級或子系統(tǒng)級設計決策與體系結(jié)構(gòu)設計。SSDD與其相關的《接口設計說明》和《數(shù)據(jù)庫設計說明》，共同構(gòu)成系統(tǒng)實現(xiàn)的基礎。GJB438B軍用軟件開發(fā)文檔通用要求SSDD的主要內(nèi)容

系統(tǒng)級設計決策：描述系統(tǒng)級設計決策，即系統(tǒng)行為的設計決策（忽略其內(nèi)部實現(xiàn)，從用戶角度出發(fā)描述系統(tǒng)將怎樣運轉(zhuǎn)以滿足需求）和其它對系統(tǒng)部件的選擇與設計產(chǎn)生影響的決策。系統(tǒng)體系結(jié)構(gòu)設計：包括系統(tǒng)部件、執(zhí)行方案、接口設計等。需求的可追蹤性：描述從本設計說明中標識的每個系統(tǒng)部件到相應的系統(tǒng)需求之間的可追蹤性，從每個系統(tǒng)需求到相應的系統(tǒng)部件之間的可追蹤性。GJB438B軍用軟件開發(fā)文檔通用要求接口設計說明（IDD）描述一個或多個系統(tǒng)或子系統(tǒng)、硬件配置項（HWCI）、計算機軟件配置項（CSCI）、人工操作，或者其它系統(tǒng)部件的接口特性。一個IDD可以描述多個接口。IDD可作為《系統(tǒng)或子系統(tǒng)設計說明》、《軟件設計說明》和《數(shù)據(jù)庫設計說明》的補充。IDD與其相關的《接口需求規(guī)格說明》可用于接口設計決策的交流和控制。GJB438B軍用軟件開發(fā)文檔通用要求IDD的主要內(nèi)容接口設計：包括接口標識和接口圖，并描述接口實體的單方或雙方的接口特性等。需求的可追蹤性：描述從本文檔中每個接口實體到相應的系統(tǒng)或計算機軟件配置項需求之間的可追蹤性，從影響本文檔接口的每個系統(tǒng)或計算機軟件配置項需求到相應接口實體之間的可追蹤性。GJB438B軍用軟件開發(fā)文檔通用要求軟件需求規(guī)格說明（SRS）描述對計算機軟件配置項（CSCI）的需求，及確保滿足每個需求所使用的方法。與CSCI外部接口有關的需求既可在本SRS中描述，也可在本SRS引用的一個或多個《接口需求規(guī)格說明》中描述。SRS可由《接口需求規(guī)格說明》補充，共同構(gòu)成CSCI設計與合格性測試的基礎。GJB438B軍用軟件開發(fā)文檔通用要求SRS的主要內(nèi)容需求：描述CSCI要求的狀態(tài)和方式、CSCI能力需求、CSCI外部接口需求、CSCI內(nèi)部接口需求、CSCI內(nèi)部數(shù)據(jù)需求、適應性需求、安全性需求、保密性需求、CSCI環(huán)境需求、計算機資源需求、軟件質(zhì)量因素、設計和實現(xiàn)約束、人員需求、培訓需求、軟件保障需求、驗收交付和包裝需求、需求的優(yōu)先順序和關鍵程度等。合格性規(guī)定：描述為確保每個需求得到滿足所定義使用的方法。需求可追蹤性。

GJB438B軍用軟件開發(fā)文檔通用要求軟件設計說明（SDD）描述計算機軟件配置項（CSCI）的設計，SDD的內(nèi)容包括計算機軟件配置項（CSCI）級設計決策、計算機軟件配置項（CSCI）體系結(jié)構(gòu)設計（概要設計）和實現(xiàn)該軟件所需的詳細設計。SDD與其相關的《接口設計說明》和《數(shù)據(jù)庫設計說明》，共同構(gòu)成軟件實現(xiàn)的基礎。GJB438B軍用軟件開發(fā)文檔通用要求SDD主要內(nèi)容CSCI級設計決策：描述CSCI級設計決策，即CSCI行為設計的決策和其它影響組成該CSCI的軟件單元的選擇與設計的決策。CSCI體系結(jié)構(gòu)設計：包括CSCI部件、執(zhí)行方案、接口設計等。CSCI詳細設計：對軟件單元進行說明。需求可追蹤性。GJB438B軍用軟件開發(fā)文檔通用要求數(shù)據(jù)庫設計說明（DBDD）描述數(shù)據(jù)庫的設計以及存取或操縱數(shù)據(jù)所使用的軟件單元。DBDD是實現(xiàn)數(shù)據(jù)庫及相關軟件單元的基礎。GJB438B軍用軟件開發(fā)文檔通用要求DBDD主要內(nèi)容數(shù)據(jù)庫級設計決策：描述數(shù)據(jù)庫級設計決策，即數(shù)據(jù)庫的行為設計決策以及其它影響數(shù)據(jù)庫進一步設計的決策。數(shù)據(jù)庫詳細設計：標識數(shù)據(jù)庫設計級別，描述數(shù)據(jù)庫的數(shù)據(jù)元素和數(shù)據(jù)元素集合。用于數(shù)據(jù)庫訪問或操縱的軟件單元的詳細設計：標識軟件單元，并對該單元進行說明。需求可追蹤性。GJB438B軍用軟件開發(fā)文檔通用要求軟件測試說明（STD）描述執(zhí)行計算機軟件配置項（CSCI）、軟件系統(tǒng)或子系統(tǒng)合格性測試所需的測試準備、測試用例及測試過程。需方根據(jù)STD可評估所執(zhí)行的合格性測試是否充分。GJB438B軍用軟件開發(fā)文檔通用要求STD的主要內(nèi)容測試準備：描述各測試項測試所需的硬件準備、軟件準備和其他人員活動、準備工作或規(guī)程過程等。測試說明：標識各測試項的測試用例所涉及的CSCI需求或系統(tǒng)需求、執(zhí)行測試用例前必須建立的先決條件、測試用例所需的測試輸入、預期的測試結(jié)果、用于評價測試用例的中間和最終結(jié)果的準則、測試用例的測試過程、任何假設以及系統(tǒng)或測試條件給測試用例帶來的約束或限制等。需求的可追蹤性。GJB438B軍用軟件開發(fā)文檔通用要求軟件測試報告（STR）是對計算機軟件配置項（CSCI）、軟件系統(tǒng)或子系統(tǒng)進行合格性測試的記錄。需方根據(jù)STR可評估測試及其結(jié)果。GJB438B軍用軟件開發(fā)文檔通用要求STR的主要內(nèi)容測試結(jié)果概述：描述對被測試軟件的總體評估，給出測試環(huán)境與操作環(huán)境的差異及這種差異對測試結(jié)果的影響進行的評估，對被測試軟件的設計、操作或測試提供改進建議。詳細測試結(jié)果：描述對各測試項的測試結(jié)果的總結(jié)，描述與該測試相關聯(lián)的每個測試用例的完成狀態(tài)，標識遇到的問題和與測試用例/過程的偏差等。GJB438B軍用軟件開發(fā)文檔通用要求軟件產(chǎn)品規(guī)格說明（SPS）描述或引用可執(zhí)行軟件、源文件以及軟件保障信息。SPS的內(nèi)容包括“已建成”CSCI的設計信息，以及編譯、構(gòu)建和修改規(guī)程等。SPS可用于為CSCI訂購可執(zhí)行軟件和（或）源文件，是CSCI的主要軟件保障文檔。GJB438B軍用軟件開發(fā)文檔通用要求SPS的主要內(nèi)容需求：給出CSCI的可執(zhí)行軟件、CSCI的源文件、將CSCI拷貝打包和加標記的需求。合格性規(guī)定：描述用于證明指定軟件實體是CSCI有效拷貝所使用的方法。軟件支持信息：描述“已建成”CSCI設計的信息，描述從源文件創(chuàng)建可執(zhí)行文件和準備向固件或其它分布媒體中加載可執(zhí)行文件所要使用的編譯/建立過程，描述修改CSCI必須遵循的過程，描述“已建成”CSCI對計算機硬件資源的實際使用情況。需求的可追蹤性。GJB438B軍用軟件開發(fā)文檔通用要求軟件版本說明（SVD）標識并描述由一個或多個計算機軟件配置項（CSCI）組成的軟件版本，用于發(fā)布、追蹤以及控制軟件版本。GJB438B軍用軟件開發(fā)文檔通用要求SVD的主要內(nèi)容版本說明：列出構(gòu)成所發(fā)布軟件的所有物理媒體和有關的文檔、構(gòu)成所發(fā)布軟件版本的所有計算機文件，給出記錄當前的軟件版本自上一個版本后引入的所有更改列表，標識或引用包含在軟件版本中的所有場地的唯一數(shù)據(jù)，列出與所發(fā)布軟件有關但未包含在其中的所有文檔，描述軟件安裝的有關說明、軟件版本在發(fā)布時可能發(fā)生的問題和已知的錯誤等。GJB438B軍用軟件開發(fā)文檔通用要求軟件用戶手冊（SUM）描述操作該軟件的用戶如何安裝與使用計算機軟件配置項（CSCI）、相關的CSCI、軟件系統(tǒng)或子系統(tǒng)。SUM可能還包括軟件運行的某些特殊方面，如特定位置或任務的說明等。若軟件由用戶運行并且具有用戶接口以獲取聯(lián)機用戶輸入或解釋輸出顯示，則需要SUM。如果軟件是一個硬件-軟件系統(tǒng)中的嵌入式軟件，則該系統(tǒng)的用戶手冊或操作手冊可能包括了SUM的內(nèi)容，不必再單獨編制SUM。本文檔也可代替《軟件輸入/輸出手冊》和《軟件中心操作員手冊。GJB438B軍用軟件開發(fā)文檔通用要求SUM的主要內(nèi)容軟件綜述：簡要說明軟件預期的用途，標識使軟件運行而必須安裝的所有軟件文件，描述用戶安裝并運行該軟件所需的硬件、軟件、手工操作和其它的資源，簡要描述軟件的組織與操作，說明在緊急時刻以及在不同運行狀態(tài)和方式下用戶處理軟件的差異，描述與軟件有關的保密性考慮，給出幫助和問題報告等方面的信息。軟件入門：描述軟件的首次用戶熟悉設備、訪問控制、安裝和設置等方面的信息，描述開始工作的步驟以及用戶如何停止或中斷軟件的使用；使用軟件指南：向用戶提供使用軟件的過程，提供軟件使用概述，描述軟件使用的任何約定，處理過程，描述創(chuàng)建和保留備份數(shù)據(jù)的過程，給出從處理過程中發(fā)生的錯誤或誤操作中重啟或恢復的詳細步驟以及確保緊急時刻運行的連續(xù)性的詳細步驟，列出完成用戶功能時可能發(fā)生的所有錯誤消息，診斷消息和信息消息等。GJB438B軍用軟件開發(fā)文檔通用要求軟件輸入/輸出手冊（SIOM）是為安裝在計算機中心或在其它集中式或網(wǎng)絡化安裝場所的軟件系統(tǒng)而編制的，用戶通過終端或個人計算機訪問該系統(tǒng)，或者以批處理方式或以交互的方式提交輸入和解釋輸出。SIOM常與《軟件中心操作員手冊》一起使用，此時可代替《軟件用戶手冊》。GJB438B軍用軟件開發(fā)文檔通用要求SIOM的主要內(nèi)容軟件環(huán)境：簡要說明軟件預期的使用、軟件清單、訪問和使用該軟件所需的軟件環(huán)境，描述軟件的組織與操作，描述在緊急時刻以及在不同運行狀態(tài)和方式下用戶處理該軟件時的差異，描述與軟件使用相關的保密性考慮、幫助和問題報告方面的信息。使用軟件：啟動軟件所必須遵循的過程、準備軟件的每種類型或類別的輸入時遵守的條件、使用的布局格式、應遵守的規(guī)則和約定、必須使用的合法字符組合或編碼等，描述每一類型或類別輸出信息、布局、出現(xiàn)在輸出中所有編碼或縮略語，描述輸出的使用，列出軟件產(chǎn)生的錯誤代碼描述用戶應采取的糾正動作，描述針對通信確認和問題識別與分類方面用戶可用的診斷過程。查詢過程：描述能被查詢的數(shù)據(jù)庫/數(shù)據(jù)文件的內(nèi)容與格式的用戶視圖、軟件提供的預排程序的查詢能力和特別的查詢能力、對查詢準備的說明，提供抽取查詢請求響應所需要的運行序列和其他動作的指令。用戶終端處理過程：分條向用戶提供使用終端完成處理的信息，包括可用的能力、訪問過程、顯示更新和檢索的過程、恢復和錯誤糾正過程、結(jié)束過程等。GJB438B軍用軟件開發(fā)文檔通用要求軟件中心操作員手冊（SCOM）是為計算機中心或在其它集中式或網(wǎng)絡化的安裝場所工作的人員，提供如何安裝和操作軟件系統(tǒng)的信息而編制的。用戶通過終端或個人計算機訪問該系統(tǒng)，或以批處理方式或以交互的方式提交和接受輸入與輸出。SCOM常與《軟件輸入/輸出手冊》一起使用，此時可代替《軟件用戶手冊》。GJB438B軍用軟件開發(fā)文檔通用要求SCOM的主要內(nèi)容軟件綜述：簡要說明軟件預期的用途，標識使軟件運行而必須安裝的數(shù)據(jù)庫和數(shù)據(jù)文件，描述用戶安裝并運行該軟件所需的硬件、軟件、手工操作和其它的資源，簡要描述軟件的組織與操作，說明在緊急時刻以及在不同運行狀態(tài)和方式下用戶處理軟件的差異，描述與軟件有關的保密性考慮，給出幫助和問題報告等方面的信息。安裝和設置：描述在設備上安裝、配置本軟件，刪除或覆蓋舊版本的文件或數(shù)據(jù)，輸入軟件運行所需的參數(shù)時必須執(zhí)行的規(guī)程。運行描述：描述要執(zhí)行的運行，包括運行清單、階段劃分、診斷過程、錯誤信息列表、每個運行的說明等。GJB438B軍用軟件開發(fā)文檔通用要求計算機編程手冊（CPM）為程序員描述對指定計算機進行編程所需要的信息。GJB438B軍用軟件開發(fā)文檔通用要求CPM的主要內(nèi)容軟件編程環(huán)境：描述計算機系統(tǒng)的部件和配置情況，描述計算機系統(tǒng)的操作特性、能力和限制，描述在計算機系統(tǒng)上執(zhí)行編譯與匯編所需要的設備。編程信息：描述計算機指令集體系結(jié)構(gòu)的編程特征、計算機系統(tǒng)的每條指令、輸入和輸出控制信息，描述與計算機系統(tǒng)有關的附加的、受限的或?qū)Ｓ玫木幊碳夹g，舉例說明上面的編程特性，描述與計算機系統(tǒng)相關的錯誤檢測和診斷特性等。GJB438B軍用軟件開發(fā)文檔通用要求計算機操作手冊（COM）描述操作指定的計算機及其外部設備所需要的信息。GJB438B軍用軟件開發(fā)文檔通用要求COM的主要內(nèi)容計算機系統(tǒng)操作：描述計算機系統(tǒng)的加點和斷電的操作規(guī)程，操作規(guī)程，問題處理規(guī)程等。診斷特征：概述計算機系統(tǒng)的診斷特征、相應的診斷規(guī)程、診斷工具等。GJB438B軍用軟件開發(fā)文檔通用要求固件保障手冊（FSM）描述對系統(tǒng)的固件設備進行編程和再編程所需的信息，也描述為擦除固件設備、向固件設備加載軟件、驗證加載過程和標記已加載的固件設備所需的固件設備和裝備、軟件以及規(guī)程，適用于只讀存儲器（ROM）、可編程ROM（PROM）、可擦除PROM（EPROM）以及其它固件設備。GJB438B軍用軟件開發(fā)文檔通用要求FSM的主要內(nèi)容固件編程指令：針對系統(tǒng)中要使用的各被編程固件設備，應描述其預編程設備、寫入設備的軟件、編程設備、編程軟件、編程規(guī)程、安裝和修復規(guī)程、供應商信息等。GJB438B軍用軟件開發(fā)文檔通用要求軟件研制總結(jié)報告（SDSR)描述軟件用途、主要功能、運行情況以及整個研制過程。GJB438B軍用軟件開發(fā)文檔通用要求SDSR的主要內(nèi)容任務來源與研制依據(jù)。軟件概述：說明軟件用途，主要功能、性能要求，軟件運行依附的設備的外部邏輯關系，軟件系統(tǒng)內(nèi)部多個計算機軟件配置項之間的構(gòu)成關系，及其開發(fā)語言、開發(fā)平臺、運行平臺、代碼規(guī)模、軟件版本、軟件關鍵性等級等信息。軟件研制過程：描述軟件研制過程開展工作情況，描述軟件參加系統(tǒng)聯(lián)試、試驗考核等情況，描述功能和性能指標、軟件需求（含接口需求）、軟件設計、軟件代碼的重大變更情況，描述軟件研制各活動所采用的方法和工作產(chǎn)品。GJB438B軍用軟件開發(fā)文檔通用要求SDSR的主要內(nèi)容（續(xù)）軟件滿足任務指標情況：描述軟件任務所要求的功能和性能指標，并根據(jù)軟件測評和軟件試驗的結(jié)果，逐項說明指標的滿足情況。質(zhì)量保證情況：描述質(zhì)量保證措施實施情況、軟件重大技術質(zhì)量問題和解決情況等。配置管理情況：描述需方對軟件配置管理的要求以及分承制對軟件配置管理的要求，說明軟件配置管理實施情況、軟件配置狀態(tài)變更情況。測量和分析：給出對開發(fā)期間產(chǎn)生的數(shù)據(jù)匯總和分析。結(jié)論：評述軟件工程化實施情況，說明軟件功能和性能指標是否滿足軟件任務的要求，給出軟件是否可以交付需方使用的結(jié)論。GJB438B軍用軟件開發(fā)文檔通用要求附錄

附錄包括上述文檔的模板。GJB438B軍用軟件開發(fā)文檔通用要求GJB438B的特點

GJB438B符合GJB2786A標準，可滿足了執(zhí)行GJB2786A所產(chǎn)生的軍用軟件開發(fā)文檔的要求，適用于軍用軟件開發(fā)過程中文檔的編制。該標準在考慮軟件定型、GJB5000A有關要求的基礎上，增加了軟件研制任務書、軟件質(zhì)量保證計劃、軟件配置管理計劃、軟件研制總結(jié)報告等文檔，并在軟件開發(fā)計劃、軟件質(zhì)量保證計劃、配置管理計劃中，對GJB5000A二級有關要求，給予了適當考慮和體現(xiàn)。此外，該標準還對原GJB438A內(nèi)容進行了調(diào)整，將文檔要求部分作為一般要求和詳細要求，刪除了文檔的目錄格式部分，將文檔的內(nèi)容正文格式作為附錄處理。G