系統(tǒng)設(shè)計說明書模板樣本

系統(tǒng)設(shè)計闡明書闡明：1.《系統(tǒng)設(shè)計闡明書》描述了系統(tǒng)或子系統(tǒng)系統(tǒng)級或子系統(tǒng)級設(shè)計與體系構(gòu)造設(shè)計。SSDD也許還要用《接口設(shè)計闡明》(IDD)和《數(shù)據(jù)庫(頂層)設(shè)計闡明》(DBDD)加以補充。2.SSDD連同有關(guān)IDD和DBDD是構(gòu)成進一步系統(tǒng)實現(xiàn)基本。貫穿本文術(shù)語“系統(tǒng)，，如果合用話，也可解釋為“子系統(tǒng)”。所形成文檔應(yīng)冠名為“系統(tǒng)設(shè)計闡明”或“子系統(tǒng)設(shè)計闡明”。目錄系統(tǒng)設(shè)計闡明書 11引言 31.1標(biāo)記 31.2系統(tǒng)概述 31.3文檔概述 31.4基線 32引用文獻 33系統(tǒng)級設(shè)計決策 34系統(tǒng)體系構(gòu)造設(shè)計 44.1系統(tǒng)總體設(shè)計 44.1.1概述 44.1.2設(shè)計思想 54.1.3基本解決流程 54.1.4系統(tǒng)體系構(gòu)造 54.1.5功能需求與系統(tǒng)配備項關(guān)系 64.1.6人工解決過程 64.2系統(tǒng)部件 64.3執(zhí)行概念 74.4接口設(shè)計 74.4.1接口標(biāo)記和圖表 75運營設(shè)計 95.1系統(tǒng)初始化 95.2運營控制 95.3運營結(jié)束 96系統(tǒng)出錯解決設(shè)計 96.1出錯信息 96.2補救辦法 97系統(tǒng)維護設(shè)計 97.1檢測點設(shè)計 97.2檢測專用模塊設(shè)計 108尚待解決問題 109需求可追蹤性 1010注解 10附錄 101引言1.1標(biāo)記本條應(yīng)包括本文檔合用系統(tǒng)和軟件完整標(biāo)記，(若合用)涉及標(biāo)記號、標(biāo)題、縮略詞語、版本號和發(fā)布號。1.2系統(tǒng)概述本條應(yīng)簡述本文檔合用系統(tǒng)和軟件用途，它應(yīng)涉及：描述系統(tǒng)和軟件普通特性；概述系統(tǒng)開發(fā)、運營和維護歷史；標(biāo)記項目投資方、需方、顧客、開發(fā)方和支持機構(gòu)；標(biāo)記當(dāng)前和籌劃中運營現(xiàn)場；列出其她關(guān)于文檔。1.3文檔概述本條應(yīng)概述本文檔用途和內(nèi)容，并描述與其使用關(guān)于保密性或私密性規(guī)定。1.4基線闡明編寫本系統(tǒng)設(shè)計闡明書根據(jù)設(shè)計基線。2引用文獻本章應(yīng)列出本文檔引用所有文檔編號、標(biāo)題、修訂版本和日期，也應(yīng)標(biāo)記不能通過正常供貨渠道獲得所有文檔來源。3系統(tǒng)級設(shè)計決策本章可依照需要分條描述系統(tǒng)級設(shè)計決策，即系統(tǒng)行為設(shè)計決策(忽視其內(nèi)部實現(xiàn)，從顧客角度出發(fā)，描述系統(tǒng)將如何運轉(zhuǎn)以滿足需求，)和其她對系統(tǒng)部件選取和設(shè)計產(chǎn)生影響決策。如果所有這些決策在需求中明確指出或推遲到系統(tǒng)部件設(shè)計時給出話，本章應(yīng)如實陳述。相應(yīng)于指定為核心性需求(如安全性、保密性和私密性需求)設(shè)計決策應(yīng)在單獨條中描述。如果設(shè)計決策依賴于系統(tǒng)狀態(tài)或方式，應(yīng)指明這種依賴關(guān)系。應(yīng)給出或引用為理解這些設(shè)計所需要設(shè)計商定。系統(tǒng)級設(shè)計決策例子如下：a.關(guān)于系統(tǒng)接受輸入和產(chǎn)生輸出設(shè)計決策，涉及與其她系統(tǒng)、配備項和顧客接口(在4.3.x標(biāo)記了在本文檔中所要考慮主題)。如果接口設(shè)計闡明ODD)中給出某些或所有該類信息，在此可以引用；b.對每個輸入或條件進行響應(yīng)系統(tǒng)行為設(shè)計決策，應(yīng)涉及：系統(tǒng)執(zhí)行動作、響應(yīng)時間和其她性能特性、被模式化物理系統(tǒng)描述、所選取方程式/算法/規(guī)則、對不容許輸入或條件解決；c.系統(tǒng)數(shù)據(jù)庫/數(shù)據(jù)文獻如何呈現(xiàn)給顧客設(shè)計決策(在4.3.x標(biāo)記了本文檔中所要考慮主題)。如果數(shù)據(jù)庫(頂層)設(shè)計闡明(DBDD)中給出某些或所有該類信息，在此可以引用；d.為滿足安全性、保密性和私密性需求所選用辦法；e.硬件或硬軟件系統(tǒng)設(shè)計和構(gòu)造選取。如：物理尺寸、顏色、形狀、重量、材料和標(biāo)志；f.為了響應(yīng)需求而作出其她系統(tǒng)級設(shè)計決策，如為提供所需靈活性、可用性和可維護性而選取辦法。4系統(tǒng)體系構(gòu)造設(shè)計本章分條描述系統(tǒng)體系構(gòu)造設(shè)計。如果設(shè)計某些或所有依賴于系統(tǒng)狀態(tài)或方式，應(yīng)指明這種依賴關(guān)系。如果設(shè)計信息在多條中浮現(xiàn)，可以只描述一次，而在其她條加以引用。也需指出或引用為理解這些設(shè)計所需設(shè)計商定。注：為簡要起見，本章描述是把一種系統(tǒng)直接組織成由硬件配備項(HWCI)、計算機軟件配備項(CSCI)、手工操作所構(gòu)成，但應(yīng)解釋為它涵蓋了把一種系統(tǒng)組織成子系統(tǒng)，子系統(tǒng)被組織成由HWCI.CSCI、手工操作構(gòu)成，或其她恰當(dāng)變種狀況。4.1系統(tǒng)總體設(shè)計4.1.1概述4.1.1.1功能描述參照本系統(tǒng)《系統(tǒng)/子系統(tǒng)需求規(guī)格闡明》，闡明對本系統(tǒng)要實現(xiàn)功能、性能(涉及：響應(yīng)時間、安全性、兼容性、可移植性、資源使用等)規(guī)定。4.1.1.2運營環(huán)境參照本系統(tǒng)《系統(tǒng)/子系統(tǒng)需求規(guī)格闡明》，簡要闡明對本系統(tǒng)運營環(huán)境(涉及硬件環(huán)境和支持環(huán)境)規(guī)定。4.1.2設(shè)計思想4.1.2.1系統(tǒng)構(gòu)思闡明本系統(tǒng)設(shè)計系統(tǒng)構(gòu)思。4.1.2.2核心技術(shù)與算法簡要闡明本系統(tǒng)設(shè)計采用核心技術(shù)和重要算法。4.1.2.3核心數(shù)據(jù)構(gòu)造簡要闡明本系統(tǒng)實現(xiàn)中最重要數(shù)據(jù)構(gòu)造。4.1.3基本解決流程4.1.3.1系統(tǒng)流程圖用流程圖表達本系統(tǒng)重要控制流程和解決流程。4.1.3.2數(shù)據(jù)流程圖用數(shù)據(jù)流程圖表達本系統(tǒng)重要數(shù)據(jù)通路，并闡明解決重要階段。4.1.4系統(tǒng)體系構(gòu)造4.1.4.1系統(tǒng)配備項闡明本系統(tǒng)中各配備項(子系統(tǒng)、模塊、子程序和公用程序等)劃分，簡要闡明每個配備項標(biāo)記符和功能等(用一覽表和框圖形式闡明)。4.1.4.2系統(tǒng)層次構(gòu)造分層次地給出各個系統(tǒng)配備項之間控制與被控制關(guān)系。4.1.4.3系統(tǒng)配備項設(shè)計擬定每個系統(tǒng)配備項功能。若是較大系統(tǒng)，可以依照需要對系統(tǒng)配備項作進一步劃分及設(shè)計。4.1.5功能需求與系統(tǒng)配備項關(guān)系闡明各項系統(tǒng)功能實現(xiàn)同各系統(tǒng)配備項分派關(guān)系(最佳用矩陣圖方式)。4.1.6人工解決過程闡明在本系統(tǒng)運營過程中包括人工解決過程(若有話)。4.2系統(tǒng)部件本條應(yīng)：a.標(biāo)記所有系統(tǒng)部件(HWCI,CSCI、手工操作)，應(yīng)為每個部件指定一種項目唯一標(biāo)記符。注：數(shù)據(jù)庫可作為一種CSCI或CSCI一某些進行解決。b.闡明部件之間靜態(tài)(如構(gòu)成)關(guān)系。依照所選取設(shè)計辦法學(xué)，也許會給出多重關(guān)系。c.陳述每個部件用途，并標(biāo)記部件相相應(yīng)系統(tǒng)需求和系統(tǒng)級設(shè)計決策(作為一種變通，可在9.a中給出需求分派)。d.標(biāo)記每個部件開發(fā)狀態(tài)/類型，如果已知話(如新開發(fā)部件、對已有部件進行重用部件、對已有設(shè)計進行重用部件、再工程已有設(shè)計或部件、為重用而開發(fā)部件和籌劃用于第N開發(fā)階段部件等等)，對已有設(shè)計或部件，此描述應(yīng)提供諸如名稱、版本、文檔引用、地點等標(biāo)記信息。e.對被標(biāo)記用于該系統(tǒng)每個計算機系統(tǒng)或其她計算機硬件資源集合，描述其計算機硬件資源(如解決器、存儲器、輸入/輸出設(shè)備、輔存器、通信/網(wǎng)絡(luò)設(shè)備)。(若合用)每一描述應(yīng)標(biāo)記出使用資源配備項，對使用資源每個CSCI闡明資源使用分派狀況(如分派給CSCI1：20％資源、給CSCI2：30％資源)，闡明在什么條件下測量資源使用狀況，闡明資源特性；1)計算機解決器描述，(若合用)應(yīng)涉及：制造商名稱和型號、解決器速度/能力、指令集體系構(gòu)造、合用編譯程序、字長(每個計算機字位數(shù))、字符集原則(如GB2312,GB18030等)和中斷能力等；2)存儲器描述.(若合用)應(yīng)涉及：制造商名稱和型號，存儲器大小、類型、速度和配備(如：256K高速緩沖存儲器,16MBRAM(4MBx4))；3)輸入/輸出設(shè)備描述，(若合用)應(yīng)涉及：制造商名稱和型號、設(shè)備類型和設(shè)備速度或能力；4)外存描述，(若合用)應(yīng)涉及：制造商名稱和型號、存儲器類型、安裝存儲器數(shù)量、存儲器速度；5)通信/網(wǎng)絡(luò)設(shè)備，(若合用)諸如：調(diào)制解調(diào)器、網(wǎng)卡、集線器、網(wǎng)關(guān)、電纜、高速數(shù)據(jù)線以及這些部件或其她部件集合體描述。(若合用)應(yīng)涉及：制造商名稱和型號、數(shù)據(jù)傳送速率/能力、網(wǎng)絡(luò)拓撲構(gòu)造、傳播技術(shù)、使用合同；6)(若合用)每個描述也應(yīng)涉及：增長能力、診斷能力以及與本描述有關(guān)其她硬件能力。f.給出系統(tǒng)規(guī)格闡明樹，即：用一種圖來標(biāo)記和闡明系統(tǒng)部件已籌劃規(guī)格闡明之間關(guān)系.4.3執(zhí)行概念本條應(yīng)描述系統(tǒng)部件之間執(zhí)行概念。用圖示和闡明表達部件之間動態(tài)關(guān)系，即系統(tǒng)運營期間它們是如何交互，(若合用)涉及：執(zhí)行控制流，數(shù)據(jù)流，動態(tài)控制序列，狀態(tài)轉(zhuǎn)換圖，時序圖，部件優(yōu)先級別，中斷解決，時序/序列關(guān)系，異常解決，并發(fā)執(zhí)行，動態(tài)分派/去分派，對象、進程、任務(wù)動態(tài)創(chuàng)立/刪除，以及動態(tài)行為其她方面。4.4接口設(shè)計本條應(yīng)分條描述系統(tǒng)部件接口特性，它應(yīng)涉及：部件之間接口及它們與外部實體(如：其她系統(tǒng)、配備項、顧客)之間接口。注：本層不需要對這些接口進行完全設(shè)計提供本條目是為了把她們作為系統(tǒng)體系構(gòu)造設(shè)計一某些所做接口設(shè)計決策記錄下來如果在接口設(shè)計闡明(IDD)或其她文檔中具有某些或所有該類信息，可以加以引用.4.4.1接口標(biāo)記和圖表本條用項目唯一標(biāo)記符標(biāo)記每個接口，(若合用)并用名稱、編號、版本、文檔引用來指明接口實體(如：系統(tǒng)、配備項、顧客等)。該標(biāo)記應(yīng)論述哪些實體具備固定接口特性(從而要把接口需求強加給接口實體)、哪些實體正被開發(fā)或修改(因而已把接口需求強加于它們)。應(yīng)提供一種或各種接口圖表來描述這些接口。4.4.x(接口項目唯一標(biāo)記符)本條(從4.4.2開始)應(yīng)用項目唯一標(biāo)記符標(biāo)記接口，簡要描述接口實體，并依照需要可分條描述接口實體單方或雙方接口特性。如果某個接口實體不在本文中(如，一種外部系統(tǒng))，但其接口特性需要在描述本文論述接口實體時提到，則這些特性應(yīng)以假設(shè)、或“當(dāng)［未提到實體］這樣做時，[本文提及實體]將……”形式描述。本條可引用其她文檔(例如數(shù)據(jù)字典、合同原則和顧客接口原則)代替本條描述信息。(若合用)本設(shè)計闡明應(yīng)涉及如下內(nèi)容，它們可以任何適合于要提供信息順序給出，并且應(yīng)從接口實體角度指出這些特性之間區(qū)別(例如數(shù)據(jù)元素大小、頻率或其她特性不同盼望)：a.接口實體分派給接口優(yōu)先級別；b.要實現(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)計量單位(如：米、元、納秒)；5)范疇或也許值枚舉(如:0-99)；6)精確度(對的限度)和精度(有效數(shù)字位數(shù))；7)優(yōu)先級別、時序、頻率、容量、序列和其她約束，如：數(shù)據(jù)元素與否可被更新、業(yè)務(wù)規(guī)則與否合用；8)保密性和私密性約束；9)來源(設(shè)立/發(fā)送實體)和接受者(使用/接受實體)。d.接口實體必要提供、存儲、發(fā)送、訪問、接受數(shù)據(jù)元素集合體(記錄、消息、文獻、數(shù)組、顯示、報告等)特性，如：1)名稱/標(biāo)記符；a)供追蹤用項目唯一標(biāo)記符；b)非技術(shù)(自然語言)名稱；c)技術(shù)名稱(如代碼或數(shù)據(jù)庫記錄或數(shù)據(jù)構(gòu)造)；d)縮寫名或同義名；2)數(shù)據(jù)元素集合體中數(shù)據(jù)元素及其構(gòu)造(編號、順序和分組)；3)媒體(如盤)和媒體中數(shù)據(jù)元素/集合體構(gòu)造；4)顯示和其她輸出視聽特性(如：顏色、版面設(shè)計、字體、圖和其她顯示元素、蜂鳴聲以及亮度)；5)數(shù)據(jù)元素集合體之間關(guān)系。如排序/訪間特性；6)優(yōu)先級別、時序、頻率、容量、序列和其她約束，如：集合體與否可被修改、業(yè)務(wù)規(guī)則與否合用；7)保密性和私密性約束；8)來源(設(shè)立/發(fā)送實體)和接受者(使用/接受實體)。e.接口實體為該接口使用通信辦法特性。如：1)項目唯一標(biāo)記符；2)通信鏈路/帶寬/頻率/媒體及其特性；3)消息格式化；4)流控制(如：序列編號和緩沖區(qū)別配)；5)數(shù)據(jù)傳送速率，周期性/非周期性和傳播間隔；6)路由、尋址和命名商定；7)傳播服務(wù)，涉及：優(yōu)先級別和級別；8)安全性/保密性/私密性方面考慮，如：加密、顧客鑒別、隔離和審核。f.接口實體為該接口使用合同特性，如：1)項目唯一標(biāo)記符；2)合同優(yōu)先級別/層次；3)分組，涉及：分段和重組、路由和尋址；4)合法性檢查、錯誤控制和恢復(fù)過程；5)同步，涉及：連接建立、保持、終結(jié)；6)狀態(tài)、標(biāo)記和其她報告特性。g.其她所需特性，如：接口實體物理兼容性(尺寸、容限、負荷、電壓和接插件兼容性等)。5運營設(shè)計5.1系統(tǒng)初始化闡明本系統(tǒng)初始化過程。5.2運營控制a.闡明對系統(tǒng)施加不同外界運營控制時所引起各種不同運營模塊組合，闡明每種運營所歷經(jīng)內(nèi)部模塊和支持軟件；b.闡明每一種外界運營控制方式辦法和操作環(huán)節(jié)；c.闡明每種運營模塊組合將占用各種資源狀況；d.闡明系統(tǒng)運營時安全控制。5.3運營結(jié)束闡明本系統(tǒng)運營結(jié)束過程。6系統(tǒng)出錯解決設(shè)計6.1出錯信息涉及出錯信息表、故障解決技術(shù)等。6.2補救辦法闡明故障浮現(xiàn)后也許采用補救辦法。7系統(tǒng)維護設(shè)計闡明為了系統(tǒng)維護以便，在系統(tǒng)內(nèi)部設(shè)計中作出安排。7.1檢測點設(shè)計闡明在系統(tǒng)中專門安排用于系統(tǒng)檢查與維護檢測點。7.2檢測專用模塊設(shè)計闡明在系統(tǒng)中專門安排用于系