系統(tǒng)設計說明書-模板

系統(tǒng)設計說明書說明：1.《系統(tǒng)設計說明書》描述了系統(tǒng)或子系統(tǒng)的系統(tǒng)級或子系統(tǒng)級設計與體系結構設計。 SSDD可能還要用《接口設計說明》(IDD)和《數據庫(頂層)設計說明》(DBDD)加以補充。連同相關的IDD和DBDD是構成進一步系統(tǒng)實現的基礎。貫穿本文的術語“系統(tǒng)，，如果適用的話，也可解釋為“子系統(tǒng)”。所形成的文檔應冠名為“系統(tǒng)設計說明”或“子系統(tǒng)設計說明”。目錄系統(tǒng)設計說明書 錯誤!未定義書簽引言錯誤!未定義書簽。標識錯誤!未定義書簽。系統(tǒng)概述錯誤!未定義書簽。文檔概述錯誤!未定義書簽?；€錯誤!未定義書簽。引用文件錯誤!未定義書簽。系統(tǒng)級設計決策錯誤!未定義書簽。系統(tǒng)體系結構設計 錯誤!未定義書簽。系統(tǒng)總體設計錯誤!未定義書簽。概述錯誤!未定義書簽。設計思想錯誤!未定義書簽?；咎幚砹鞒体e誤!未定義書簽。系統(tǒng)體系結構錯誤!未定義書簽。功能需求與系統(tǒng)配置項的關系 錯誤!未定義書簽人工處理過程錯誤!未定義書簽。系統(tǒng)部件錯誤!未定義書簽。執(zhí)行概念錯誤!未定義書簽。接口設計錯誤!未定義書簽。接口標識和圖表 錯誤!未定義書簽。運行設計錯誤!未定義書簽。系統(tǒng)初始化錯誤!未定義書簽。運行控制錯誤!未定義書簽。運行結束錯誤!未定義書簽。系統(tǒng)出錯處理設計 錯誤!未定義書簽。出錯信息錯誤!未定義書簽。補救措施錯誤!未定義書簽。系統(tǒng)維護設計 錯誤!未定義書簽。檢測點的設計錯誤!未定義書簽。檢測專用模塊的設計 錯誤!未定義書簽。尚待解決的問題錯誤!未定義書簽。需求的可追蹤性錯誤!未定義書簽。注解錯誤!未定義書簽。附錄錯誤!未定義書簽。引言標識本條應包含本文檔適用的系統(tǒng)和軟件的完整標識， （若適用）包括標識號、標題、縮略詞語、版本號和發(fā)布號。系統(tǒng)概述本條應簡述本文檔適用的系統(tǒng)和軟件的用途，它應包括：描述系統(tǒng)和軟件的一般特性；概述系統(tǒng)開發(fā)、運行和維護的歷史；標識項目的投資方、需方、用戶、開發(fā)方和支持機構；標識當前和計劃中的運行現場；列出其他有關的文檔。文檔概述本條應概述本文檔的用途和內容，并描述與其使用有關的保密性或私密性要求?；€說明編寫本系統(tǒng)設計說明書依據的設計基線。引用文件本章應列出本文檔引用的所有文檔的編號、標題、修訂版本和日期，也應標識不能通過正常的供貨渠道獲得的所有文檔的來源。系統(tǒng)級設計決策本章可根據需要分條描述系統(tǒng)級設計決策，即系統(tǒng)行為的設計決策（忽略其內部實現，從用戶角度出發(fā)，描述系統(tǒng)將怎樣運轉以滿足需求， ）和其他對系統(tǒng)部件的選擇和設計產生影響的決策。如果所有這些決策在需求中明確指出或推遲到系統(tǒng)部件的設計時給出的話，本章應如實陳述。對應于指定為關鍵性需求（如安全性、保密性和私密性需求）的設計決策應在單獨的條中描述。如果設計決策依賴于系統(tǒng)狀態(tài)或方式，應指明這種依賴關系。應給出或引用為理解這些設計所需要的設計約定。系統(tǒng)級設計決策例子如下：有關系統(tǒng)接收的輸入和產生的輸出的設計決策，包括與其他系統(tǒng)、配置項和用戶的接口 （在標識了在本文檔中所要考慮的主題）。如果接口設計說明ODD）中給出部分或全部該類信息，在此可以引用；對每個輸入或條件進行響應的系統(tǒng)行為的設計決策，應包括：系統(tǒng)執(zhí)行的動作、響應時間和其他性能特性、被模式化的物理系統(tǒng)的描述、所選擇的方程式 /算法/規(guī)則、對不允許的輸入或條件的處理；系統(tǒng)數據庫/數據文件如何呈現給用戶的設計決策 （在標識了本文檔中所要考慮的主題 ）。如果數據庫（頂層）設計說明（DBDD）中給出部分或全部該類信息，在此可以引用；為滿足安全性、保密性和私密性需求所選用的方法；硬件或硬軟件系統(tǒng)的設計和構造選擇。如：物理尺寸、顏色、形狀、重量、材料和標志；為了響應需求而作出的其他系統(tǒng)級設計決策，如為提供所需的靈活性、可用性和可維護性而選擇的方法。系統(tǒng)體系結構設計本章分條描述系統(tǒng)體系結構設計。如果設計的部分或全部依賴于系統(tǒng)狀態(tài)或方式，應指明這種依賴關系。如果設計信息在多條中出現，可以只描述一次，而在其他條加以引用。也需指出或引用為理解這些設計所需的設計約定。注：為簡明起見，本章的描述是把一個系統(tǒng)直接組織成由硬件配置項 （HWCI）、計算機軟件配置項（CSCI、）手工操作所組成，但應解釋為它涵蓋了把一個系統(tǒng)組織成子系統(tǒng)，子系統(tǒng)被組織成由、手工操作組成，或其他適當變種的情況。系統(tǒng)總體設計概述功能描述參考本系統(tǒng)的《系統(tǒng)/子系統(tǒng)需求規(guī)格說明》，說明對本系統(tǒng)要實現的功能、性能 （包括：響應時間、安全性、兼容性、可移植性、資源使用等 ）要求。運行環(huán)境參考本系統(tǒng)的《系統(tǒng)/子系統(tǒng)需求規(guī)格說明》，簡要說明對本系統(tǒng)的運行環(huán)境 （包括硬件環(huán)境和支持環(huán)境）的規(guī)定。設計思想系統(tǒng)構思說明本系統(tǒng)設計的系統(tǒng)構思。關鍵技術與算法簡要說明本系統(tǒng)設計采用的關鍵技術和主要算法。關鍵數據結構簡要說明本系統(tǒng)實現中的最主要的數據結構?；咎幚砹鞒滔到y(tǒng)流程圖用流程圖表示本系統(tǒng)的主要控制流程和處理流程。數據流程圖用數據流程圖表示本系統(tǒng)的主要數據通路，并說明處理的主要階段。系統(tǒng)體系結構系統(tǒng)配置項說明本系統(tǒng)中各配置項（子系統(tǒng)、模塊、子程序和公用程序等 ）的劃分，簡要說明每個配置項的標識符和功能等（用一覽表和框圖的形式說明）。系統(tǒng)層次結構分層次地給出各個系統(tǒng)配置項之間的控制與被控制關系。系統(tǒng)配置項設計確定每個系統(tǒng)配置項的功能。若是較大的系統(tǒng)，可以根據需要對系統(tǒng)配置項作進一步的劃分及設計。功能需求與系統(tǒng)配置項的關系說明各項系統(tǒng)功能的實現同各系統(tǒng)配置項的分配關系 （最好用矩陣圖的方式）。人工處理過程說明在本系統(tǒng)的運行過程中包含的人工處理過程 （若有的話）。系統(tǒng)部件本條應：標識所有系統(tǒng)部件（HWCI,CSC、I手工操作），應為每個部件指定一個項目唯一標識符。注：數據庫可作為一個CSCI或CSCI的一部分進行處理。說明部件之間的靜態(tài)（如組成）關系。根據所選擇的設計方法學，可能會給出多重關系。陳述每個部件的用途，并標識部件相對應的系統(tǒng)需求和系統(tǒng)級設計決策 （作為一種變通，可在中給出需求的分配）。標識每個部件的開發(fā)狀態(tài)/類型，如果已知的話（如新開發(fā)的部件、對已有部件進行重用的部件、對已有設計進行重用的部件、再工程的已有設計或部件、為重用而開發(fā)的部件和計劃用于第N開發(fā)階段的部件等等），對已有的設計或部件，此描述應提供諸如名稱、版本、文檔引用、地點等標識信息。對被標識用于該系統(tǒng)的每個計算機系統(tǒng)或其他計算機硬件資源的集合， 描述其計算機硬件資源（如處理器、存儲器、輸入/輸出設備、輔存器、通信/網絡設備）。（若適用）每一描述應標識出使用資源的配置項，對使用資源的每個 CSCI說明資源使用分配情況（如分配給CSCI1：20％的資源、給CSCI2：30％的資源），說明在什么條件下測量資源的使用情況，說明資源特性；1）計算機處理器描述，（若適用）應包括：制造商名稱和型號、處理器速度/能力、指令集體系結構、適用的編譯程序、字長（每個計算機字的位數）、字符集標準（如GB2312,GB18030等）和中斷能力等；2）存儲器描述.（若適用）應包括：制造商名稱和型號，存儲器大小、類型、速度和配置 （如：256K高速緩沖存儲器,16MBRAM（4MBx4））；3）輸入/輸出設備描述，（若適用）應包括：制造商名稱和型號、設備類型和設備的速度或能力；4）外存描述，（若適用）應包括：制造商名稱和型號、存儲器類型、安裝存儲器的數量、存儲器速度；5）通信/網絡設備，（若適用）諸如：調制解調器、網卡、集線器、網關、電纜、高速數據線以及這些部件或其他部件的集合體的描述。 （若適用）應包括：制造商名稱和型號、數據傳送速率 /能力、網絡拓撲結構、傳輸技術、使用的協(xié)議；6）（若適用）每個描述也應包括：增長能力、診斷能力以及與本描述相關的其他的硬件能力。給出系統(tǒng)的規(guī)格說明樹，即：用一個圖來標識和說明系統(tǒng)部件已計劃的規(guī)格說明之間的關系 .執(zhí)行概念本條應描述系統(tǒng)部件之間的執(zhí)行概念。用圖示和說明表示部件之間的動態(tài)關系，即系統(tǒng)運行期間它們是如何交互的，（若適用）包括：執(zhí)行控制流，數據流，動態(tài)控制序列，狀態(tài)轉換圖，時序圖，部件的優(yōu)先級別，中斷處理，時序 /序列關系，異常處理，并發(fā)執(zhí)行，動態(tài)分配 /去分配，對象、進程、任務的動態(tài)創(chuàng)建/刪除，以及動態(tài)行為的其他方面。接口設計本條應分條描述系統(tǒng)部件的接口特性，它應包括：部件之間的接口及它們與外部實體 （如：其他系統(tǒng)、配置項、用戶）之間的接口。注：本層不需要對這些接口進行完全設計提供本條的目的是為了把他們作為系統(tǒng)體系結構設計的一部分所做的接口設計決策記錄下來如果在接口設計說明 （IDD）或其他文檔中含有部分或全部的該類信息，可以加以引用.接口標識和圖表本條用項目唯一標識符標識每個接口， （若適用）并用名稱、編號、版本、文檔引用來指明接口實體（如：系統(tǒng)、配置項、用戶等）。該標識應敘述哪些實體具有固定接口特性（從而要把接口需求強加給接口實體）、哪些實體正被開發(fā)或修改（因而已把接口需求強加于它們）。應提供一個或多個接口圖表來描述這些接口。接口的項目唯一標識符）本條（從開始）應用項目唯一標識符標識接口，簡要描述接口實體，并根據需要可分條描述接口實體單方或雙方的接口特性。如果某個接口實體不在本文中 （如，一個外部系統(tǒng)），但其接口特性需要在描述本文敘述的接口實體時提到，則這些特性應以假設、或“當［未提到實體］這樣做時，［本文提及的實體］將??”的形式描述。本條可引用其他文檔 （例如數據字典、協(xié)議標準和用戶接口標準）代替本條的描述信息。（若適用）本設計說明應包括以下內容，它們可以任何適合于要提供的信息的順序給出，并且應從接口實體角度指出這些特性之間的區(qū)別 （例如數據元素的大小、頻率或其他特性的不同期望）：接口實體分配給接口的優(yōu)先級別；要實現的接口的類型（如：實時數據傳送、數據的存儲和檢索等 ）；接口實體將提供、存儲、發(fā)送、訪問和接收的單個數據元素的特性，如：1）名稱/標識符：a）項目唯一標識符；b）非技術（自然語言）名稱；c）標準數據元素名稱；d）技術名稱（如代碼或數據庫中變量或字段名稱 ）；e）縮寫名或同義名；2）數據類型（字母數字字符、整數等）；3）大小和格式（如：字符串長度和標點符號）；4）計量單位（如：米、元、納秒）；5）范圍或可能值的枚舉（如:0-99）；6）準確度（正確程度）和精度（有效數字位數）；7）優(yōu)先級別、時序、頻率、容量、序列和其他約束，如：數據元素是否可被更新、業(yè)務規(guī)則是否適用；8）保密性和私密性約束；9）來源（設置/發(fā)送實體）和接收者（使用/接收實體）。接口實體必須提供、存儲、發(fā)送、訪問、接收的數據元素集合體 （記錄、消息、文件、數組、顯示、報告等）的特性，如：1）名稱/標識符；a）供追蹤用的項目唯一標識符；b）非技術（自然語言）名稱；c）技術名稱（如代碼或數據庫的記錄或數據結構 ）；d）縮寫名或同義名；2）數據元素集合體中的數據元素及其結構 （編號、次序和分組）；3）媒體（如盤）和媒體中數據元素/集合體的結構；4）顯示和其他輸出的視聽特性（如：顏色、版面設計、字體、圖和其他顯示元素、蜂鳴聲以及亮度）；5）數據元素集合體之間的關系。如排序 /訪間特性；6）優(yōu)先級別、時序、頻率、容量、序列和其他約束，如：集合體是否可被修改、業(yè)務規(guī)則是否適用；7）保密性和私密性約束；8）來源（設置/發(fā)送實體）和接收者（使用/接收實體）。接口實體為該接口使用通信方法的特性。如：1）項目唯一標識符；2）通信鏈路/帶寬/頻率/媒體及其特性；3）消息格式化；4）流控制（如：序列編號和緩沖區(qū)分配）；5）數據傳送速率，周期性/非周期性和傳輸間隔；6）路由、尋址和命名約定；7）傳輸服務，包括：優(yōu)先級別和等級；8）安全性/保密性/私密性方面的考慮，如：加密、用戶鑒別、隔離和審核。接口實體為該接口使用協(xié)議的特性，如：1）項目唯一標識符；2）協(xié)議的優(yōu)先級別/層次；3）分組，包括：分段和重組、路由和尋址；4）合法性檢查、錯誤控制和恢復過程；5）同步，包括：連接的建立、保持、終止；6）狀態(tài)、標識和其他的報告特征。其他所需的特性，如：接口實體的物理兼容性 （尺寸、容限、負荷、電壓和接插件兼容性等 ）。運行設計系統(tǒng)初始化說明本系統(tǒng)的初始化過程。運行控制說明對系統(tǒng)施加不同的外界運行控制時所引起的各種不同的運行模塊組合， 說明每種運行所歷經的內部模塊和支持軟件；說明每一種外界運行控制的方式方法和操作步驟；說明每種運行模塊組合將占用各種資源的情況；說明系統(tǒng)運行時的安全控制。運行結束說明本系統(tǒng)運行的結束過程。系統(tǒng)出錯處理設計出錯信息包括出錯信息表、故障處理技術等。補救措施說明故障出現后可能采取的補救措施。系統(tǒng)維護設計說明為了系統(tǒng)維護的方便，在系統(tǒng)內部設計中作出的安排。檢測點的設計說明在系統(tǒng)中專門安排用于系統(tǒng)檢查與維護的檢測點。檢測專用模塊的設計說明在系統(tǒng)中專門安