系統(tǒng)設(shè)計(jì)說明書-模板資料

1、系統(tǒng)設(shè)計(jì)說明書-模板系統(tǒng)設(shè)計(jì)說明書說明：1.系統(tǒng)設(shè)計(jì)說明書描述了系統(tǒng)或子系統(tǒng)的系統(tǒng)級(jí)或子系統(tǒng)級(jí)設(shè)計(jì)與體系結(jié) 構(gòu)設(shè)計(jì)。SSDD可能還要用接口設(shè)計(jì)說明(IDD)和數(shù)據(jù)庫(kù)(頂層)設(shè)計(jì)說 明(DBDD)加以補(bǔ)充。2.SSDD連同相關(guān)的IDD和DBDD是構(gòu)成進(jìn)一步系統(tǒng)實(shí)現(xiàn)的基礎(chǔ)。貫穿本文的 術(shù)語“系統(tǒng)，如果適用的話，也可解釋為“子系統(tǒng)”。所形成的文檔應(yīng)冠名為“系 統(tǒng)設(shè)計(jì)說明”或“子系統(tǒng)設(shè)計(jì)說明”。目錄 TOC o 1-5 h z HYPERLINK l bookmark1 o Current Document 系統(tǒng)設(shè)計(jì)說明書2 HYPERLINK l bookmark4 o Current Docume

2、nt 1引言41.1標(biāo)識(shí)4 HYPERLINK l bookmark7 o Current Document 1.2系統(tǒng)概述4 HYPERLINK l bookmark10 o Current Document 1.3文檔概述41.4基線4 HYPERLINK l bookmark13 o Current Document 2引用文件5 HYPERLINK l bookmark16 o Current Document 3系統(tǒng)級(jí)設(shè)計(jì)決策5 HYPERLINK l bookmark24 o Current Document 4系統(tǒng)體系結(jié)構(gòu)設(shè)計(jì)6 HYPERLINK l bookmark27 o

3、Current Document 4.1系統(tǒng)總體設(shè)計(jì).74.1.1 概述74.1.2設(shè)計(jì)思想74.1.3基本處理流程84.1.4系統(tǒng)體系結(jié)構(gòu)8 HYPERLINK l bookmark50 o Current Document 4.1.5功能需求與系統(tǒng)配置項(xiàng)的關(guān)系8 HYPERLINK l bookmark53 o Current Document 4.1.6人工處理過程9 HYPERLINK l bookmark56 o Current Document 4.2系統(tǒng)部件9 HYPERLINK l bookmark71 o Current Document 4.3執(zhí)行概念10 HYPERLIN

4、K l bookmark74 o Current Document 4.4接口設(shè)計(jì)11 HYPERLINK l bookmark77 o Current Document 4.4.1接口標(biāo)識(shí)和圖表11 HYPERLINK l bookmark127 o Current Document 5運(yùn)行設(shè)計(jì)14 HYPERLINK l bookmark130 o Current Document 5.1系統(tǒng)初始化14 HYPERLINK l bookmark133 o Current Document 5.2運(yùn)行控制14 HYPERLINK l bookmark140 o Current Documen

5、t 5.3運(yùn)行結(jié)束15 HYPERLINK l bookmark143 o Current Document 6系統(tǒng)出錯(cuò)處理設(shè)計(jì)15 HYPERLINK l bookmark146 o Current Document 6.1出錯(cuò)信息15 HYPERLINK l bookmark149 o Current Document 6.2補(bǔ)救措施15 HYPERLINK l bookmark152 o Current Document 7系統(tǒng)維護(hù)設(shè)計(jì)15 HYPERLINK l bookmark155 o Current Document 7.1檢測(cè)點(diǎn)的設(shè)計(jì)15 HYPERLINK l bookmar

6、k158 o Current Document 7.2檢測(cè)專用模塊的設(shè)計(jì)15 HYPERLINK l bookmark161 o Current Document 8尚待解決的問題16 HYPERLINK l bookmark164 o Current Document 9需求的可追蹤性16 HYPERLINK l bookmark169 o Current Document 10注解16 HYPERLINK l bookmark172 o Current Document 附錄161引言1.1標(biāo)識(shí)本條應(yīng)包含本文檔適用的系統(tǒng)和軟件的完整標(biāo)識(shí)，（若適用）包括標(biāo)識(shí)號(hào)、標(biāo)題、縮略詞語、版本號(hào)和發(fā)布號(hào)

7、。1.2系統(tǒng)概述本條應(yīng)簡(jiǎn)述本文檔適用的系統(tǒng)和軟件的用途，它應(yīng)包括：描述系統(tǒng)和軟件的一 般特性；概述系統(tǒng)開發(fā)、運(yùn)行和維護(hù)的歷史；標(biāo)識(shí)項(xiàng)目的投資方、需方、用 戶、開發(fā)方和支持機(jī)構(gòu)；標(biāo)識(shí)當(dāng)前和計(jì)劃中的運(yùn)行現(xiàn)場(chǎng)；列出其他有關(guān)的文 檔。1.3文檔概述本條應(yīng)概述本文檔的用途和內(nèi)容，并描述與其使用有關(guān)的保密性或私密性要 求。1.4基線說明編寫本系統(tǒng)設(shè)計(jì)說明書依據(jù)的設(shè)計(jì)基線。2引用文件本章應(yīng)列出本文檔引用的所有文檔的編號(hào)、標(biāo)題、修訂版本和日期，也應(yīng)標(biāo)識(shí) 不能通過正常的供貨渠道獲得的所有文檔的來源。3系統(tǒng)級(jí)設(shè)計(jì)決策本章可根據(jù)需要分條描述系統(tǒng)級(jí)設(shè)計(jì)決策，即系統(tǒng)行為的設(shè)計(jì)決策（忽略其內(nèi)部 實(shí)現(xiàn)，從用戶角度出發(fā)，描述

8、系統(tǒng)將怎樣運(yùn)轉(zhuǎn)以滿足需求，）和其他對(duì)系統(tǒng)部件 的選擇和設(shè)計(jì)產(chǎn)生影響的決策。如果所有這些決策在需求中明確指出或推遲到 系統(tǒng)部件的設(shè)計(jì)時(shí)給出的話，本章應(yīng)如實(shí)陳述。對(duì)應(yīng)于指定為關(guān)鍵性需求（如安 全性、保密性和私密性需求）的設(shè)計(jì)決策應(yīng)在單獨(dú)的條中描述。如果設(shè)計(jì)決策依 賴于系統(tǒng)狀態(tài)或方式，應(yīng)指明這種依賴關(guān)系。應(yīng)給出或引用為理解這些設(shè)計(jì)所 需要的設(shè)計(jì)約定。系統(tǒng)級(jí)設(shè)計(jì)決策例子如下：有關(guān)系統(tǒng)接收的輸入和產(chǎn)生的輸出的設(shè)計(jì)決策，包括與其他系統(tǒng)、配置項(xiàng)和 用戶的接口（在4.3.x標(biāo)識(shí)了在本文檔中所要考慮的主題）。如果接口設(shè)計(jì)說明 ODD）中給出部分或全部該類信息，在此可以引用；對(duì)每個(gè)輸入或條件進(jìn)行響應(yīng)的系統(tǒng)行為的設(shè)

9、計(jì)決策，應(yīng)包括：系統(tǒng)執(zhí)行的動(dòng) 作、響應(yīng)時(shí)間和其他性能特性、被模式化的物理系統(tǒng)的描述、所選擇的方程式/ 算法/規(guī)則、對(duì)不允許的輸入或條件的處理；系統(tǒng)數(shù)據(jù)庫(kù)/數(shù)據(jù)文件如何呈現(xiàn)給用戶的設(shè)計(jì)決策(在4.3.x標(biāo)識(shí)了本文檔中所 要考慮的主題)。如果數(shù)據(jù)庫(kù)(頂層)設(shè)計(jì)說明(DBDD)中給出部分或全部該類信 息，在此可以引用；為滿足安全性、保密性和私密性需求所選用的方法；硬件或硬軟件系統(tǒng)的設(shè)計(jì)和構(gòu)造選擇。如：物理尺寸、顏色、形狀、重量、 材料和標(biāo)志；為了響應(yīng)需求而作出的其他系統(tǒng)級(jí)設(shè)計(jì)決策，如為提供所需的靈活性、可用性 和可維護(hù)性而選擇的方法。4系統(tǒng)體系結(jié)構(gòu)設(shè)計(jì)本章分條描述系統(tǒng)體系結(jié)構(gòu)設(shè)計(jì)。如果設(shè)計(jì)的部分或全

10、部依賴于系統(tǒng)狀態(tài)或方 式，應(yīng)指明這種依賴關(guān)系。如果設(shè)計(jì)信息在多條中出現(xiàn)，可以只描述一次，而 在其他條加以引用。也需指出或引用為理解這些設(shè)計(jì)所需的設(shè)計(jì)約定。注：為簡(jiǎn)明起見，本章的描述是把一個(gè)系統(tǒng)直接組織成由硬件配置項(xiàng)(HWCI)、 計(jì)算機(jī)軟件配置項(xiàng)(CSCI)、手工操作所組成，但應(yīng)解釋為它涵蓋了把一個(gè)系統(tǒng) 組織成子系統(tǒng)，子系統(tǒng)被組織成由HWCI.CSCI、手工操作組成，或其他適當(dāng)變 種的情況。4.1系統(tǒng)總體設(shè)計(jì)4.1.1概述4.1.1.1功能描述參考本系統(tǒng)的系統(tǒng)/子系統(tǒng)需求規(guī)格說明，說明對(duì)本系統(tǒng)要實(shí)現(xiàn)的功能、性 能（包括：響應(yīng)時(shí)間、安全性、兼容性、可移植性、資源使用等）要求。4.1.1.2運(yùn)行環(huán)

11、境參考本系統(tǒng)的系統(tǒng)/子系統(tǒng)需求規(guī)格說明，簡(jiǎn)要說明對(duì)本系統(tǒng)的運(yùn)行環(huán)境 （包括硬件環(huán)境和支持環(huán)境）的規(guī)定。4.1.2設(shè)計(jì)思想4.1.2.1系統(tǒng)構(gòu)思說明本系統(tǒng)設(shè)計(jì)的系統(tǒng)構(gòu)思。4.1.2.2關(guān)鍵技術(shù)與算法簡(jiǎn)要說明本系統(tǒng)設(shè)計(jì)采用的關(guān)鍵技術(shù)和主要算法。4.1.2.3關(guān)鍵數(shù)據(jù)結(jié)構(gòu)簡(jiǎn)要說明本系統(tǒng)實(shí)現(xiàn)中的最主要的數(shù)據(jù)結(jié)構(gòu)。4.1.3基本處理流程413.1系統(tǒng)流程圖用流程圖表示本系統(tǒng)的主要控制流程和處理流程。4.1.3.2數(shù)據(jù)流程圖用數(shù)據(jù)流程圖表示本系統(tǒng)的主要數(shù)據(jù)通路，并說明處理的主要階段。4.1.4系統(tǒng)體系結(jié)構(gòu)4.1.4.1系統(tǒng)配置項(xiàng)說明本系統(tǒng)中各配置項(xiàng)（子系統(tǒng)、模塊、子程序和公用程序等）的劃分，簡(jiǎn)要說 明每個(gè)

12、配置項(xiàng)的標(biāo)識(shí)符和功能等（用一覽表和框圖的形式說明）。4.1.4.2系統(tǒng)層次結(jié)構(gòu)分層次地給出各個(gè)系統(tǒng)配置項(xiàng)之間的控制與被控制關(guān)系。4.1.4.3系統(tǒng)配置項(xiàng)設(shè)計(jì)確定每個(gè)系統(tǒng)配置項(xiàng)的功能。若是較大的系統(tǒng)，可以根據(jù)需要對(duì)系統(tǒng)配置項(xiàng)作 進(jìn)一步的劃分及設(shè)計(jì)。4.1.5功能需求與系統(tǒng)配置項(xiàng)的關(guān)系說明各項(xiàng)系統(tǒng)功能的實(shí)現(xiàn)同各系統(tǒng)配置項(xiàng)的分配關(guān)系（最好用矩陣圖的方式）。4.1.6人工處理過程說明在本系統(tǒng)的運(yùn)行過程中包含的人工處理過程（若有的話）。4.2系統(tǒng)部件本條應(yīng)：標(biāo)識(shí)所有系統(tǒng)部件（HWCI,CSCI、手工操作），應(yīng)為每個(gè)部件指定一個(gè)項(xiàng)目唯一 標(biāo)識(shí)符。注：數(shù)據(jù)庫(kù)可作為一個(gè)CSCI或CSCI的一部分進(jìn)行處理。說明

13、部件之間的靜態(tài)（如組成）關(guān)系。根據(jù)所選擇的設(shè)計(jì)方法學(xué)，可能會(huì)給出多 重關(guān)系。陳述每個(gè)部件的用途，并標(biāo)識(shí)部件相對(duì)應(yīng)的系統(tǒng)需求和系統(tǒng)級(jí)設(shè)計(jì)決策（作為 一種變通，可在9.a中給出需求的分配）。標(biāo)識(shí)每個(gè)部件的開發(fā)狀態(tài)/類型，如果已知的話（如新開發(fā)的部件、對(duì)已有部件 進(jìn)行重用的部件、對(duì)已有設(shè)計(jì)進(jìn)行重用的部件、再工程的已有設(shè)計(jì)或部件、為 重用而開發(fā)的部件和計(jì)劃用于第N開發(fā)階段的部件等等），對(duì)已有的設(shè)計(jì)或部 件，此描述應(yīng)提供諸如名稱、版本、文檔引用、地點(diǎn)等標(biāo)識(shí)信息。對(duì)被標(biāo)識(shí)用于該系統(tǒng)的每個(gè)計(jì)算機(jī)系統(tǒng)或其他計(jì)算機(jī)硬件資源的集合，描述 其計(jì)算機(jī)硬件資源（如處理器、存儲(chǔ)器、輸入/輸出設(shè)備、輔存器、通信/網(wǎng)絡(luò)設(shè) 備

14、）。（若適用）每一描述應(yīng)標(biāo)識(shí)出使用資源的配置項(xiàng)，對(duì)使用資源的每個(gè)CSCI 說明資源使用分配情況（如分配給CSCI1 : 20%的資源、給CSCI2 : 30%的資 源），說明在什么條件下測(cè)量資源的使用情況，說明資源特性；1）計(jì)算機(jī)處理器描述，（若適用）應(yīng)包括：制造商名稱和型號(hào)、處理器速度/能 力、指令集體系結(jié)構(gòu)、適用的編譯程序、字長(zhǎng)（每個(gè)計(jì)算機(jī)字的位數(shù)）、字符集 標(biāo)準(zhǔn)（如GB2312,GB18030等）和中斷能力等；2）存儲(chǔ)器描述.（若適用）應(yīng)包括：制造商名稱和型號(hào)，存儲(chǔ)器大小、類型、速度 和配置（如：256K高速緩沖存儲(chǔ)器,16MBRAM（4MBx4）；3）輸入/輸出設(shè)備描述，（若適用）應(yīng)包

15、括：制造商名稱和型號(hào)、設(shè)備類型和設(shè)備 的速度或能力；4）外存描述，（若適用）應(yīng)包括：制造商名稱和型號(hào)、存儲(chǔ)器類型、安裝存儲(chǔ)器的 數(shù)量、存儲(chǔ)器速度；5）通信/網(wǎng)絡(luò)設(shè)備，（若適用）諸如：調(diào)制解調(diào)器、網(wǎng)卡、集線器、網(wǎng)關(guān)、電纜、 高速數(shù)據(jù)線以及這些部件或其他部件的集合體的描述。（若適用）應(yīng)包括：制造 商名稱和型號(hào)、數(shù)據(jù)傳送速率/能力、網(wǎng)絡(luò)拓?fù)浣Y(jié)構(gòu)、傳輸技術(shù)、使用的協(xié)議；6）（若適用）每個(gè)描述也應(yīng)包括：增長(zhǎng)能力、診斷能力以及與本描述相關(guān)的其他的 硬件能力。給出系統(tǒng)的規(guī)格說明樹，即：用一個(gè)圖來標(biāo)識(shí)和說明系統(tǒng)部件已計(jì)劃的規(guī)格說 明之間的關(guān)系.4.3執(zhí)行概念本條應(yīng)描述系統(tǒng)部件之間的執(zhí)行概念。用圖示和說明表示部

16、件之間的動(dòng)態(tài)關(guān) 系，即系統(tǒng)運(yùn)行期間它們是如何交互的，（若適用）包括：執(zhí)行控制流，數(shù)據(jù) 流，動(dòng)態(tài)控制序列，狀態(tài)轉(zhuǎn)換圖，時(shí)序圖，部件的優(yōu)先級(jí)別，中斷處理，時(shí)序/ 序列關(guān)系，異常處理，并發(fā)執(zhí)行，動(dòng)態(tài)分配/去分配，對(duì)象、進(jìn)程、任務(wù)的動(dòng)態(tài) 創(chuàng)建/刪除，以及動(dòng)態(tài)行為的其他方面。4.4接口設(shè)計(jì)本條應(yīng)分條描述系統(tǒng)部件的接口特性，它應(yīng)包括：部件之間的接口及它們與外 部實(shí)體（如：其他系統(tǒng)、配置項(xiàng)、用戶）之間的接口。注：本層不需要對(duì)這些接口進(jìn)行完全設(shè)計(jì)提供本條的目的是為了把他們作為系 統(tǒng)體系結(jié)構(gòu)設(shè)計(jì)的一部分所做的接口設(shè)計(jì)決策記錄下來如果在接口設(shè)計(jì)說明 （IDD）或其他文檔中含有部分或全部的該類信息，可以加以引用.4

17、.4.1接口標(biāo)識(shí)和圖表本條用項(xiàng)目唯一標(biāo)識(shí)符標(biāo)識(shí)每個(gè)接口，（若適用）并用名稱、編號(hào)、版本、文檔 引用來指明接口實(shí)體（如：系統(tǒng)、配置項(xiàng)、用戶等）。該標(biāo)識(shí)應(yīng)敘述哪些實(shí)體具 有固定接口特性（從而要把接口需求強(qiáng)加給接口實(shí)體）、哪些實(shí)體正被開發(fā)或修 改（因而已把接口需求強(qiáng)加于它們）。應(yīng)提供一個(gè)或多個(gè)接口圖表來描述這些接 口。4.4.x （接口的項(xiàng)目唯一標(biāo)識(shí)符）本條（從4.4.2開始）應(yīng)用項(xiàng)目唯一標(biāo)識(shí)符標(biāo)識(shí)接口，簡(jiǎn)要描述接口實(shí)體，并根據(jù) 需要可分條描述接口實(shí)體單方或雙方的接口特性。如果某個(gè)接口實(shí)體不在本文 中（如，一個(gè)外部系統(tǒng)），但其接口特性需要在描述本文敘述的接口實(shí)體時(shí)提 到，則這些特性應(yīng)以假設(shè)、或“當(dāng)未

18、提到實(shí)體這樣做時(shí)，本文提及的實(shí)體 將”的形式描述。本條可引用其他文檔（例如數(shù)據(jù)字典、協(xié)議標(biāo)準(zhǔn)和用戶接口 標(biāo)準(zhǔn)）代替本條的描述信息。（若適用）本設(shè)計(jì)說明應(yīng)包括以下內(nèi)容，它們可以任 何適合于要提供的信息的順序給出，并且應(yīng)從接口實(shí)體角度指出這些特性之間 的區(qū)別（例如數(shù)據(jù)元素的大小、頻率或其他特性的不同期望）:接口實(shí)體分配給接口的優(yōu)先級(jí)別；要實(shí)現(xiàn)的接口的類型（如：實(shí)時(shí)數(shù)據(jù)傳送、數(shù)據(jù)的存儲(chǔ)和檢索等）；接口實(shí)體將提供、存儲(chǔ)、發(fā)送、訪問和接收的單個(gè)數(shù)據(jù)元素的特性，如：1）名稱/標(biāo)識(shí)符：a）項(xiàng)目唯一標(biāo)識(shí)符；b）非技術(shù)（自然語言）名稱；c）標(biāo)準(zhǔn)數(shù)據(jù)元素名稱；d）技術(shù)名稱（如代碼或數(shù)據(jù)庫(kù)中變量或字段名稱）；e）縮

19、寫名或同義名；2）數(shù)據(jù)類型（字母數(shù)字字符、整數(shù)等）；3）大小和格式（如：字符串長(zhǎng)度和標(biāo)點(diǎn)符號(hào)）；4）計(jì)量單位（如：米、元、納秒）；5）范圍或可能值的枚舉（如:0-99）；6）準(zhǔn)確度（正確程度）和精度（有效數(shù)字位數(shù)）；7）優(yōu)先級(jí)別、時(shí)序、頻率、容量、序列和其他約束，如：數(shù)據(jù)元素是否可被更 新、業(yè)務(wù)規(guī)則是否適用；8）保密性和私密性約束；9）來源（設(shè)置/發(fā)送實(shí)體）和接收者（使用/接收實(shí)體）。接口實(shí)體必須提供、存儲(chǔ)、發(fā)送、訪問、接收的數(shù)據(jù)元素集合體（記錄、消息、文件、數(shù)組、顯示、報(bào)告等）的特性，如：1）名稱/標(biāo)識(shí)符；a）供追蹤用的項(xiàng)目唯一標(biāo)識(shí)符；b）非技術(shù)（自然語言）名稱；c）技術(shù)名稱（如代碼或數(shù)據(jù)庫(kù)

20、的記錄或數(shù)據(jù)結(jié)構(gòu)）；d）縮寫名或同義名；2）數(shù)據(jù)元素集合體中的數(shù)據(jù)元素及其結(jié)構(gòu)（編號(hào)、次序和分組）；3）媒體（如盤）和媒體中數(shù)據(jù)元素/集合體的結(jié)構(gòu)；4）顯示和其他輸出的視聽特性（如：顏色、版面設(shè)計(jì)、字體、圖和其他顯示元素、蜂鳴聲以及亮度）；5）數(shù)據(jù)元素集合體之間的關(guān)系。如排序/訪間特性；6）優(yōu)先級(jí)別、時(shí)序、頻率、容量、序列和其他約束，如：集合體是否可被修改、業(yè)務(wù)規(guī)則是否適用；7）保密性和私密性約束；8）來源（設(shè)置/發(fā)送實(shí)體）和接收者（使用/接收實(shí)體）。接口實(shí)體為該接口使用通信方法的特性。如：1）項(xiàng)目唯一標(biāo)識(shí)符；2）通信鏈路/帶寬/頻率/媒體及其特性；3）消息格式化；4）流控制（如：序列編號(hào)和緩沖區(qū)分配）；5）數(shù)據(jù)傳送速率，周期性/非周期性和傳輸間隔；6）路由、尋址和命名約定；7）傳輸服務(wù)，包括：優(yōu)先級(jí)別和等級(jí)；8）安全性/保密性/私密性方面的考慮，如：加密、用戶鑒別、隔離和審核。接口實(shí)體為該接口使用協(xié)議的特性，如：1）項(xiàng)目唯一標(biāo)識(shí)符；2）協(xié)議的優(yōu)先級(jí)別/層次；3）分組，包括：分段和重組、路由和尋址；4）合法性檢