軟件設計說明編寫指引438B

1、密級:（軟件項目名稱）軟件設計說明標 識：版 本：頁 數：擬 制： «SQA審核：審 核：批 準：擬制部門：“中國人民XXXXXXXXXX 研究所解放軍修改文檔歷史記錄：1范圍錯誤!未定義書簽。標識錯謀!未定義書簽。系統(tǒng)概述錯誤!未定義書簽。文檔概述錯誤!未定義書簽。2引用文檔錯誤!未定義書簽。3 CSCI級設計決策錯誤!未定義書簽。4 CSCI體系結構設計錯誤!未定義書簽。CSCI部件錯誤!未定義書簽。CSCI結構錯誤!未定義書簽。CSC描述錯誤!未定義書簽。CSC名稱和項目唯一標識號錯誤!未定義書簽。系統(tǒng)狀態(tài)和模式錯誤!未定義書簽。執(zhí)行方案錯誤!未定義書簽。CSC數據流與控制流圖

2、錯誤!未定義書簽。系統(tǒng)狀態(tài)與模式的數據流與控制流錯誤!未定義書簽。接口設計錯誤!未定義書簽。接口設計準則錯誤!未定義書簽。接口標識和接口圖錯誤!未定義書簽。（接口的項目唯一的標識符）錯誤!未定義書簽。5 CSCI詳細設計錯誤!未定義書簽。（軟件單元的項目唯一的標識符，或者一組軟件單元的標志符）錯謀!未定義書簽。6需求可追蹤性錯誤!未定義書簽。7注釋錯誤!未定義書簽。1范圍標識【本條應描述本文檔所適用的系統(tǒng)和軟件的完整標識，適用時，包括其標識號、名稱. 縮略名、版本號及發(fā)布號?！肯到y(tǒng)概述【本條應概述本文檔所適用的系統(tǒng)和軟件的用途。它還應描述系統(tǒng)與軟件的一般特性; 概述系統(tǒng)開發(fā)、運行和維護的歷史；

3、標識項目的需方.用戶.開發(fā)方和保障機構等；標識當 前和計劃的運行現(xiàn)場；列出其它有關文檔°】文檔概述【本條應概述本文檔的用途和內容，并描述與它的使用有關的保密性方面的要求?！坷罕疚臋n描述XXXX系統(tǒng)軟件的概要設計和詳細設計，其內容和格式遵循GJB438B-2009的 要求。本文檔可作為設計評審的基礎，編碼的依據，軟件測試的基準。2引用文檔【本章應列出引用文檔的編號、標題、編寫單位、修訂版本及日期。還應標識不能通過 正常采購活動得到的文檔的來源°】例:表X引用文檔文檔標識文檔名稱發(fā)布日期版本號GJB438B-2009我器系統(tǒng)軟件開發(fā)文檔2009HL1A-00CZC-09XXX

4、XXX操作程序XXX-YYY-021XXXX接口控制文件XX分卅系統(tǒng)軟件雷求規(guī)格說明3 CSCI級設計決策【本章應根據需要分條給出CSCI級設計決策，即CSCI行為設計的決策（忽略其內部實 現(xiàn)，從用戶角度出發(fā)描述系統(tǒng)將怎樣運轉以滿足需求）和其它影響組成該CSCI的軟件單元 的選擇與設計的決策。如果在需求中所有這些決策是明確的，或者這些決策要推遲到CSCI 的軟件單元的設計時指出，則本章應如實陳述。針對關鍵性需求（例如對安全性或保密性關 鍵的需求）作出的設計決策，應在專門的章節(jié)中加以敘述。如果設計決策依賴于系統(tǒng)狀態(tài)或 方式，則應指明這一依賴性。本條應給出或引用理解這些設計所需的設計約定。CSCI

5、級設 計決策的例子如下：a）關于CSCI將接收的輸入和將產生的輸出的設計決策，包括與其它系統(tǒng)、HWCI. CSCI 和用戶的接口（本文檔的條指出本說明要考慮的主題）。如果這一信息的全部或部分 已在接口設計說明（IDDs）中給出，則可以直接引用。b）有關響應每個輸入或條件的CSCI行為的設計決策，包括CSCI要執(zhí)行的動作、響應 時間和其它性能特性，模型化的物理系統(tǒng)的說明，選定的方程式/算法/規(guī)則，以及 對不允許的輸入或條件進行的處理。c）有關數據庫/數據文件如何呈現(xiàn)給用戶的設計決策（本文檔的節(jié)標識了本說明要考慮 的主題）。如果這一信息的全部或部分在數據庫設計說明（DBDD）中給出，則可直接 引用

6、。d）為滿足安全性和保密性需求所選擇的方法。e）為滿足需求所做的其它CSCI級設計決策，例如為提供所需的靈活性、可用性和可維 護性所選擇的方法?！渴纠?:從兩種技術解決方案中選出一種：XXXXXXo輸入響應設計決策：對于待處理目標，收到目標偵測設備送來的待處理目標后，利用目 標識別庫識別確定目標的敵我屬性，并進行威脅目標報告。安全性設計方法：在原系統(tǒng)的基礎上，增加安全內核，實現(xiàn)身份認證和密碼保護?？捎眯栽O計方法：利用雙機熱備份，24小時不停機，實現(xiàn)系統(tǒng)的可用性。例2：序號系統(tǒng)狀態(tài).方式 和工作時序輸入處理輸出1程序初始化自檢 狀態(tài)2狀態(tài)傳輸中斷狀態(tài)3跟蹤同步中斷狀態(tài)44 CSCI體系結構設計【

7、本章應分為以下幾條描述CSCI體系結構設計。如果設計的全部或部分依賴于系統(tǒng)的 狀態(tài)或方式，此依賴性應予指明。如果設計信息在多于一個條中出現(xiàn)，它只需被提供一次， 而在其它條中引用。本條應提供或引用為了理解設計所需要的設計約定?！緾SCI部件【本條應描述：a）構成該CSCI的所有軟件單元。應賦予每個軟件單元一個項目唯一的標識符。注：軟件單元是CSCI設計中的一個元素；例如，CSCI的一個主要分支、該主要分 支的一個組成部分，一個類、對象.模塊.函數、例程或數據庫。軟件單元可 以出現(xiàn)在層次結構的不同層上，且又可以由其它軟件單元組成。在設計中，軟 件單元與實現(xiàn)它們的代碼和數據實體（例程，過程，數據庫，

8、數據文件等），或 與包含這些實體的計算機文件之間，可以有.也可以沒有一對一的對應關系。 一個數據庫可被處理為一個CSCI也可被處理為一個軟件單元。SDD可以采用與 所使用設計方法相一致的任何名字來稱呼軟件單元。b）軟件單元的靜態(tài)（如，由組成）關系。根據所選擇的軟件設計方法學，可以給出 多種關系（例如，采用面向對象的設計方法時，本條既可給出類和對象結構，也可 給出CSCI的模塊和過程結構）。C）每個軟件單元的用途，指明分配紿它的CSCI需求和CSCI級設計決策（需求的分配 也可在6 a）中提供）。d）每個軟件單元的開發(fā)狀態(tài)/類型（如新開發(fā)、按原樣重用已有的設計或軟件、再工程 的已有的設計或軟件、

9、為重用而要開發(fā)的軟件等，為構建版N計劃的軟件）。針對 現(xiàn)有的設計或軟件，本說明應提供標識信息，例如名字.版本、文檔引用、庫等。e）CSCI （若適用，針對每個軟件單元）計劃使用的計算機硬件資源（例如處理機能力，內存能力，輸入/輸出設備能力，輔存能力以及通信/網絡設備能力）。本說明應覆蓋 CSCI的資源使用需求中、影響該CSCI的系統(tǒng)級資源分配中、以及在軟件開發(fā)計劃 （SDP）的資源使用測量策劃的中包含的全部計算機硬件資源。如果針對紿定計算機 硬件資源的所有使用數據都在同一處提供，例如在SDD中提供，那么本條可直接引 用。對每個計算機硬件資源，應包括如下信息：1）得到滿足的CSCI需求或系統(tǒng)級資

10、源分配；2）使用數據基于的假設和條件（例如，典型用法、最壞情況用法、特定事件的假定）;3）影響使用的特殊考慮（例如，虛存、覆蓋、多處理器的使用情況，操作系統(tǒng).庫 軟件的開銷或其它實現(xiàn)開銷影響”4）所使用的測度的單位（例如，處理器能力的百分比、周期/秒、內存字節(jié)數、千 字節(jié)/秒）；5）進行評估或測量的級別（例如，軟件單元，CSCI或者可執(zhí)行程序）。f）標識實現(xiàn)每個軟件單元的軟件放置在哪個程序庫中?！渴纠篊SCI結構行動 方案上報 csu方*CSU目標 識別 床卸CSU日標識8（與決策 處理軟flcsci檢制由令處ACSC訓練 曲令 處？f csu目標 關鎂 csu«z標與C方標配 我

11、IX匹圖X冃標識劃與決最處貍牧件功能模塊結構圖CSC描述CSC名稱和項目唯一標識號注：從開始，按照圖中的CSC層次關系進行編號。表2 （CSC名稱）描述CSC名稱CSC標識CSC用途下一級CSC組成設計決策CSC分配需求設計需求設計約束開發(fā)類型/狀態(tài)注:a. 如該CSC不包含下一級CSC可標注為“無”，否則逐個說明下一級的CSC名稱。b. “分配需求”為需求規(guī)格說明分配給CSC的功能、性能、安全、保密等方面需求， 可引用需求文檔相關描述或名稱標識；c. “設計需求”是從設計者的角度描述該CSC為實現(xiàn)分配需求而使用的關鍵算法、模 型、容錯處理等方面需求；d. “設計約束"是從設計者的角

12、度描述實現(xiàn)該CSC所受到的軟、硬件環(huán)境的限制，如 數據范圍、字長限制等；e. “開發(fā)類型/狀態(tài)”是指新開發(fā)、按原樣重用已有的設計或軟件.再工程的已有的設 計或軟件、為重用而要開發(fā)的軟件.為構建版N計劃的軟件等。f. 如CSC由下一級CSC組成，分配需求、設計需求.設計約束內容可引用下一級CSC 相關描述，不必重復描述；R.對于關鍵或安全性等方面有較高要求的CSC,如有必要可針對不同分配需求逐條描 述對應的設計需求、設計約束：系統(tǒng)狀態(tài)和模式表X系統(tǒng)狀態(tài)和模式系統(tǒng)狀態(tài)和模式執(zhí)行的CSCCSC名稱CSC特殊性說明注：a. 如系統(tǒng)不存在多種狀態(tài)和方式，本節(jié)可省略；b. 如某狀態(tài)和方式下對應在CSC的全

13、部功能，則只給出CSC名稱，無需進行“CSC特 殊性說明”，否則描述其功能.性能等方面的限制。目標識別和決策制定軟件的系統(tǒng)狀態(tài)和模式如下表所示：表x系統(tǒng)狀態(tài)和模式系統(tǒng)狀態(tài)和模式執(zhí)行的CSCCSC名稱CSC特殊性說明作戰(zhàn)方式控制命令處理只處理系統(tǒng)作戰(zhàn)方式的開始/停止控制命 令。目標參數處理該模塊將從目標偵測設備獲取待處理目 標參數。其它模塊無O訓練方式控制命令處理只處理系統(tǒng)訓練方式的開始/停止控制命 令。目標參數處理該模塊將從模擬目標庫中獲取待處理目 標參數。其它模塊無O執(zhí)行方案【本條應說明軟件單元間的執(zhí)行方案。可采用圖表和描述，來說明軟件單元間的動態(tài)關 系，即CSCI運行期間軟件單元間的相互作

14、用情況，（若適用）應包括執(zhí)行控制流程、數據流、 動態(tài)控制序列.狀態(tài)轉換圖、時序圖.單元間的優(yōu)先關系.中斷處理、時序/排序關系、例 外處理、并發(fā)執(zhí)行、動態(tài)分配與去除分配、對象/進程/任務的動態(tài)創(chuàng)建/刪除.以及動態(tài)行 為的其它方面?！渴纠?CSC數據流與控制流圖小敵我目標識別的數據流圖b）敵我目標識別的閣X 敢我識別的扌丸行揑制流圖系統(tǒng)狀態(tài)與模式的數據流與控制流目標識別和決策制定軟件在作戰(zhàn)方式下的控制流圖如下:開始0子寂輸入系統(tǒng)I 拎制命令控制命令處卻CSC：接收系統(tǒng)控制命令，控制系統(tǒng)狀態(tài)H標識別庫 L 敵我目標識別CSC：對目標偵 測設備送*的目標逬行處理.并匹肚目標 行動方案庫:1V；決策和方

15、案制定CSC,給出對 敵彳亍動決策，制定并上報行動 方法控制流圖描述：系統(tǒng)運行在作戰(zhàn)方式時，接收飛行員輸入的系統(tǒng)控制命令控制系統(tǒng)狀態(tài)。 系統(tǒng)在開啟狀態(tài)下，接收目標參數并進行敵我屬性識別，并上報威脅目標給飛行員。根據威 脅目標信息進行對敵行動決策，制定并上報行動方案。目標識別和決策制定軟件在作戰(zhàn)方式下的數據流圖如下所示:因X作戰(zhàn)方式數據流圖接口設計接口設計準則接口標識和接口圖【本條應說明賦予每個接口的項目唯一的標識符，（若適用）應通過名稱.編號、版本 及文檔引用來標識接口實體（軟件單元.系統(tǒng).配置項.用戶等）。該標識應說明哪些實體 具有固定的接口特性（從而把接口需求分配給這些接口實體）；說明哪些

16、實體正在開發(fā)或修 改（這些實體已有各自的接口需求）。（若適用）應通過接口圖來描述這些接口?！渴纠嚎刂泼钐幝馛SC敵我目標識別CSC>目標參 數信息決策和方案制 定CSC< 丿目標識別庫目標識別庫如表X頂層模塊內部接口描述接口 名稱接口項目唯一標識號接口簡述接口傳遞的信息概 述運行 狀態(tài)ADMS-JK-MBSB-YXZT傳遞軟件的運行 方式信息，以確定軟件接收待處理 目標參數的方式。作戰(zhàn)方式、訓練方 式標數息 目參信ADMS-JK-MBSB-MBCS傳遞威脅目標到 決策和方案制定模塊，目標的威脅等級， 高度，方向角，距離等信息。敵我目標識別內部接口示意圖<目標參數處理CSC

17、<丿目標匹配CSC7圖X敵我忖標譏別內部接口示盤圖敵我目標識別內部接口描述表X敵我目標識別內部接口描述口稱 接名述 簡 口 接勺 in IF o 財訂般非塊 將處析#.配、類、叭 位頻型焰 方載類耐速復齢阮 #飮重煉 目距型載（接口的項目唯一的標識符）【本條（從開始）應通過項目唯一標識符來標識接口，應簡要地標識接口實體，根據需 要可分條描述單方或雙方接口實體的特性。如果一指定的接口實體未包含在本SDD中（例如,一個外部系統(tǒng)），而描述接口實體需要提到其接口特性時，這些特性應作為假設予以陳述. 或以“當未涵蓋的實體這樣做時，所指定的實體將”的形式描述。本條可引用其它 文檔（例如數據字典.協(xié)議

18、標準、用戶接口標準）代替在此所描述的信息。本設計說明應包 括以下內容（若適用），以任何適合于所提供的信息的順序提供，并應從接口實體角度說明 這些特性之間的區(qū)別（例如關于數據元素的大小、頻率或其它特性的不同期望值）：a）接口實體分配給接口的優(yōu)先級；b）要實現(xiàn)的接口類型（例如實時數據傳輸、數據的存儲和檢索等”c）接口實體將提供.存儲.發(fā)送.訪問、接收的各個數據元素的特征，例如：1）名稱/標識符：（1）項目唯一的標識符；（2）非技術（自然語言）名稱；（3）數據元素名稱；（4）技術名稱（如在代碼或數據庫中的變量名或字段名）；（5）縮略名或同義名。2）數據類型（字母、數字、整數等）；3）大小與格式（如：

19、字符串的長度和標點符號）；4）計量單位（如：m等）；5）可能值的范圍或枚舉（如：0-99）；6）準確性（正確程度）和精度（有效數位數）；7）優(yōu)先級、定時、頻率.容量、序列以及其它約束條件（例如數據元素是否可以被 更新.業(yè)務規(guī)則是否適用）；8）保密性約束。9）來源（建立/發(fā)送的實體）和接受者（使用/接收的實體）。d）接口實體將提供.存儲、發(fā)送.訪問.接收的數據元素集合體（記錄.消息、文件. 數組、顯示、報表等）的待性，例如：1）名稱/標識符:（1）項目唯一的標識符；（2）非技術（自然語言）名稱；（3）技術名稱（如在代碼或數據庫中的記錄名或數據結構名）；（4）縮略名或同義名。2）數據元素集合體中的

20、數據元素及其結構（編號、順序和分組情況）；3）介質（例如磁盤）以及介質上數據元素/數據集合體的結構；4）顯示和其它輸出的視聽特性（例如顏色.布局、字體.圖標和其它顯示元素、峰 鳴聲和亮度）；5）數據組合體之間的關系，如排序/存取待性；6）優(yōu)先級、定時、頻率、容量.序列及其它約束，例如數據組合體是否可被更新、 業(yè)務規(guī)則是否適用；7）保密性約束；8）來源（建立/發(fā)送的實體）和接受者（使用/接收的實體）。e）接口實體用于接口的通信方法的特征。如：1）項目唯一的標識符；2）通信鏈接/帶寬/頻率/介質及其特性；3）消息格式；4）流控制（如：序列編號和緩沖區(qū)分配）；5）數據傳輸率、周期或非周期、傳輸間隔；

21、6）路由、尋址及命名約定；7）傳輸服務，包括：優(yōu)先級和等級；8）安全性/保密性考慮，如：加密、用戶鑒別、隔離和審核。f）接口實體用于接口的協(xié)議的特征，如：1）項目唯一的標識符；2）協(xié)議的優(yōu)先級別/層次；3）打包，包括分段與重組、路由和尋址；4）合法性檢查、錯誤控制和恢復過程；5）同步，包括連接的建立、保持和終止；6）狀態(tài)、標識和其它報告特性。K）其它特性，例如接口實體的物理兼容性（尺寸、公差、負荷、電壓和接插件的兼容 性等）?！渴纠?數據元素表X （接口）的數據元素數據元素 名稱數據元素標識描述數據類 型數據 長度測量單位極限值/值 域精度 /分 辨率來源/接受者目標標識 號ADMS-SJYS

22、-MBBS標識目標的ID無符號 整數4字節(jié)無2-1無來自“敵方目標 匹配/我方目標 匹配”載頻類型ADMS-SJYS-ZPLX耒知目標的載頻 類型無符號整型4字節(jié)無0：未知1:載頻因定2：栽頻捷變3：載頻分集無敵方目標匹配/ 我方目標匹史載頻上限ADMS-SJYS-ZPSX未知目標的載頻 上限浮點型4字節(jié)MHz10故方目標匹配/ 我方目標匹史栽頻下限ADMS-SJYS-ZPXX未知目標的載頻 下限浮點型4字節(jié)MHz10故方目標匹配/ 我方目標匹史重復問隔 類型ADMS-SJYS-CFLX耒知目標的重復 問隔類型無符號整型4字節(jié)無0：未知1:重頻因定 2：重頻抖動 3：重頻參差 4：重頻組變無敵

23、方目標匹配/ 我方目標匹史重復問隔 時問上限ADMS-SJYS-CFSX未知目標的重復 問隔時問上限浮點型4字節(jié)徹秒(T10故方目標匹配/ 我方目標匹史數據結構表數據消息描述數;居消息描述包含的數據元素/消息名稱項目唯一標識號名稱項目唯一標識號武器裝備信 息ADMS-SJXX-WQZB描述目標掛載的武器 的類型.數量和攻擊范武器類型ADMS-SJYS-WQMC武器數量ADMS-SJYS-WQSL武器攻擊范圍ADMS-SJYS-GJFW威脅目標參 數信息ADMS-SJXX-MBCS經過敵我屬性識別的 威脅目標參數信息。目標標識號ADMS-SJYS-MBBS目標屬性ADMS-SJYS-DWSX目標

24、類型ADMS-SJYS-MBLX威脅等級ADMS-SJYS-WXJB方位角ADMS-SJYS-FWJ距離ADMS-SJYS-MBJL相對高度ADMS-SJYS-FXGD武器裝備信息ADMS-SJXX-WQZB5 CSCI詳細設計（軟件單元的項目唯一的標識符，或者一組軟件單元的標志符）【本條應通過項目唯一的標識符來標識軟件單元，并對該單元進行說明。（若適用）該說 明應包括下列信息。本條也可以指定一組軟件單元，然后再分小條對它們分別進行標識和說 明。包含其他軟件單元的軟件單元可引用那些軟件單元的說明，而無需在此重復。a）（若有）單元設計決策，例如所使用的算法（如果此前尚未選定）；b）該軟件單元設計

25、中的任何約束、限定或非常規(guī)特征；c）如果使用的編程語言不同于該CSCI所指定的語言，則應指出并說明使用它的理由；d）如果該軟件單元包含過程性命令或由過程性命令組成（例如數據庫管理系統(tǒng)（DBMS） 中用于定義表單和報表的菜單選擇，用于數據庫訪問和操縱的在線DBMS查詢，用于 代碼自動生成的圖形用戶接口（GUI）構造器的輸入，操作系統(tǒng)的命令或Shell腳本）, 應列出這些過程性命令，并引用解釋它們的用戶手冊或其它文檔；e）如果該軟件單元包含、接收或輸出數據，（若適用）應對它的輸入、輸出及其它數據 元素和數據元素組合體進行說明。本文檔的條提供了（若適用）應包括的主題。軟 件單元的局部數據應與軟件單元

26、的輸入或輸出數據分開來描述。如果該軟件單元是 一個數據庫，應引用相應的數據庫設計說明（DBDD）；接口特性可以在這里提供，也 可以引用第4章或相應的接口設計說明（IDD）of）如果該軟件單元包含邏輯，給出該軟件單元所用到的邏輯，（若適用）應包括：1）該軟件單元執(zhí)行啟動時，其內部起作用的條件；2）將控制傳遞給其它軟件單元的條件；3）對每個輸入的響應以及響應時間，包括數據轉換、重命名以及數據傳輸操作；4）在軟件單元運行期間的操作順序和動態(tài)控制序列，包括：（1）順序控制的方法；（2）該方法的邏輯和輸入條件，例如時序變異、優(yōu)先級分配等；（3）進出內存的數據傳輸；（4）對稱散輸入信號的感知，以及該軟件單

27、元內中斷操作之間的時序關系。5）異常和錯誤處理?！渴纠?CSC組成CSC名稱CSC標識小節(jié)號CSU名稱CSU標識CSU之間的關系用控制流圖或數據流圖描述該CSC下的各CSU間的關系。（CSC名稱）的設計注：從開始編號。描述節(jié)所標識的CSU的詳細設計。a.設計語言與庫表 （CSU名稱）的設計CSU名稱CSU標識使用的程 序語言使用該語言理由保存CSU的庫庫名稱庫標識描述庫的設計文 檔注：1、如果CSU不是用CSCI規(guī)定語言編寫，那么應在“使用的程序語言”項中標識要使用的這一語言，并應在“使用該語言理由"項中給出使用它的理由。2、如果CSU保存在庫中，則描述相關信息，否則該列可刪除。3、如果該CSU在程序語言及庫方面沒有特殊性，本節(jié)可刪除。b.輸入/輸出元素表輸入