07軟件設計說明書模板

1、份號：001密級:裝備管理信息系統(tǒng)軟件設計說明書XXXX-RSJ-R01.00XXXXXXXX 公司XXXX年XX月XX日輯要頁項目名稱文件名稱項目代號總頁數(shù)完成單位擬 制簽名與日期職務或技術職稱楚金龍校 對審 核標 審批 準會 簽摘要：主題詞：文檔修改記錄版本號修改內(nèi)容描述修改人日期備注 TOC o 1-5 h z 1范圍1標識1 HYPERLINK l bookmark5 o Current Document 系統(tǒng)概述1 HYPERLINK l bookmark7 o Current Document 文檔概述1 HYPERLINK l bookmark9 o Current Docume

2、nt 2引用文件1 HYPERLINK l bookmark11 o Current Document CSCI級設計決策1 HYPERLINK l bookmark13 o Current Document CSCI體系結構設計2 HYPERLINK l bookmark15 o Current Document CSCI 部件2 HYPERLINK l bookmark17 o Current Document 執(zhí)行方案3接口設計3接口標識和接口圖3 HYPERLINK l bookmark22 o Current Document .X （接口的項目唯一的標識符）3CSCI詳細設計5 H

3、YPERLINK l bookmark24 o Current Document 5.X（軟件單元的項目唯一的標識符，或者一組軟件單元的標識符）5 HYPERLINK l bookmark27 o Current Document 6需求可追蹤性6 HYPERLINK l bookmark29 o Current Document 7注釋61范圍標識本條應描述本文檔所使用的系統(tǒng)和軟件的完整標識，適用時，包括其標識號、 名稱、縮略名、版本號和發(fā)布號。系統(tǒng)概述本條用概述本文檔所適用的系統(tǒng)和軟件用途。它還應描述系統(tǒng)和軟件的一般特 性：概述系統(tǒng)開發(fā)、運行和維護的歷史；標識項目的需方、用戶、開發(fā)方和保障

4、機 構等；標識當前和計劃的運行現(xiàn)場；列出其他有關文檔。文檔概述本條應描述本文檔的內(nèi)容和用途，并描述與它的使用有關的保密性方面的要 求。2引用文件本章應列出引用文檔的編號、標題、編寫單位、修訂版及日期。還應標識不能 通過正常采購活動得到的文檔的來源。CSCI級設計決策本章應根據(jù)需要分條給出CSCI級設計決策，即CSCI行為設計的決策（忽略其內(nèi) 部實現(xiàn)，從用戶角度出發(fā)描述系統(tǒng)將怎樣運轉以滿足需求）和其他影響組成該CSCI的 軟件單元的選擇與設計的決策。如果在需求中所有這些決策是明確的，或者這些決 策要推遲到CSCI的軟件單元的設計時指出，則本章應如實陳述。針對關鍵性需求（例 如對安全性或保密性關鍵

5、的需求）作出的設計決策，應在專門的章條中加以敘述。如 果設計決策依賴于系統(tǒng)狀態(tài)或方式，則應指明這一依賴性。本條應給出或引用理解 這些設計所需的設計約定。CSCI級設計決策的例子如下：a）關于CSCI將接收的輸入和將產(chǎn)生的輸出的設計決策，包括與其他系統(tǒng)、 HWCI、CSCI和用戶的接口（本文檔的4.3.X條指出本說明要考慮的主題）。 如果這一信息的全部或部分已在接口設計說明中給出，則可以直撥引用。b）有關響應每個輸入或條件的CSCI行為的設計決策，包括CSCI要執(zhí)行的動 作、響應時間和其它性能特性，模型化的物理系統(tǒng)的說明，選定的方程式/ 算法/規(guī)則，以及對不允的輸入或條件進行的處理。c）有關數(shù)據(jù)

6、庫/數(shù)據(jù)文件如何呈現(xiàn)給用戶的設計決策（本文檔的4.3.X條標識了本說明要考慮的主題）。如果這一信息的全部或部分在數(shù)據(jù)庫設計說明中給 出，則可直接引用。d）為滿足安全性和保密性需求所選擇的方法。e）為滿足需求所做的其他CSCI級設計決策，例如為提供所需的靈活性、可用 性和可維護性所選擇的力法。CSCI體系結構設計本章應分為以下幾條描述CSCI體系結構設計。如果設計的全部或部分依賴于系 統(tǒng)的狀態(tài)或方式，此依賴性應予指明。如果設計信息在多于一個條中出現(xiàn)，它只需 被提供一次，而在其他條中引用。本條應提供成引用為了理解設計所需要的設計約 定。CSCI 部件本條應描述：a）構成該CSCI的所有軟件單元。應

7、賦予每個軟件單元一個項目唯一的標識符。 注：軟件單元是CSCI設計中的一個元素；例如CSCI的一個主要分支、該主要分支的一 個組成部分，一個類、對象、模塊、函數(shù)、例程或數(shù)據(jù)庫。軟件單元可以出現(xiàn)在層次 結構的不同層上，且又可以由其他軟件單元組成。在設計中，軟件單元與實現(xiàn)它們的 代碼和數(shù)據(jù)實體（例程，過程，數(shù)據(jù)庫，數(shù)據(jù)文件等），或與包含這些實體的計算機文 件之間，可以有、也可以沒有一對一的對應關系。一個數(shù)據(jù)庫可被處理為一個CSCI也 可被處理為一個軟件單元?？梢圆捎门c所使用設計方法相一致的任何名字來稱呼軟件 單元。b）軟件單元的靜態(tài)（如，由組成）關系。根據(jù)所選擇的軟件設計方法學，可以 給出多種關系

8、（例如，采用面向?qū)ο蟮脑O計方法時，本條既可給出類和對象 結構，也可給出CSCI的模塊和過程結構）。c）每個軟件單元的用途，指明分配給它的CSCI需求和CSCI級設計決策（需求的 分配也可在6a）中提供）。d）每個軟件單元的開發(fā)狀態(tài)/類型（如新開發(fā)、按原樣重用已有的設計或軟件、 再工程的己有的設計或軟件、為重用而要開發(fā)的軟件等，為構建版N計劃的 軟件）。針對現(xiàn)有的設計或軟件，本說明應提供標識信息，例如名字、版 本、文檔引用、庫等。e） CSCI（若適用，針對每個軟件單元）計劃使用的計算機硬件資源（例如處理機 能力，內(nèi)存能力，輸入/輸出設備能力，輔存能力以及通信/網(wǎng)絡設備能 力）。本說明應覆蓋CS

9、CI的資源使用需求中、影響該CSCI的系統(tǒng)級資源分配中、以及在軟件開發(fā)計劃的資源使用測量策劃中包含的全部計算機硬件資 源。如果針對指定計算機硬件資源的所有使用數(shù)據(jù)都在同一處提供，例如在 軟件設計說明中提供，那么本條可直接引用。對每個計算機硬件資源，應包 括如下信息：1）得到滿足的CSCI需求或系統(tǒng)級資源分配；2）使用數(shù)據(jù)基于的假設和條件（例如，典型用法、最刻、最壞情況用法、特 定事件的假定）；3）影響使用的特殊考慮（例如，虛存、覆蓋、多處理器的使用情況，操作系 統(tǒng)、庫軟件的開銷或其他實現(xiàn)開銷的影響）；4）所使用的測度的單位（例如，處理器能力的百分比、周期/秒、內(nèi)存字節(jié) 數(shù)、千字節(jié)/秒）；5）進

10、行評估或測量的級別（例如，軟件單元.CSCI或者可執(zhí)行程序）。f）標識實現(xiàn)每個軟件單元的軟件放置在哪個程序庫中。執(zhí)行方案本條應說明軟件單元間的執(zhí)行方案，可采用圖表和描述，來說明軟件單元間的 動態(tài)關系.即運行期間軟件單元間的相互作用情況，（若適用）應包括執(zhí)行控制流程、 數(shù)據(jù)流、動態(tài)控制序列、狀態(tài)轉換圖、時序圖、單元間的優(yōu)先關系、中斷處理、時 序/排序關系、例外處理、并發(fā)執(zhí)行、動態(tài)分配與去除分配、對象/進程/任務的動態(tài) 創(chuàng)建/刪除、以及動態(tài)行為的其他方面。接口設計接口標識和接口圖本條應說明賦予每個接口的項目唯一的標識符，（若適用）成通過名稱、編號、 版本及文檔引用來標識接口實體（軟件單元、系統(tǒng)、配

11、置項、用戶等）。該標識應說 明哪些實體具有固定的接口特性（從而把接口需求分配給汶些接口立體）；說明哪些 實體正在開發(fā)或修改（這些實體已有各自的接口需求）。（若適用）應通過接口圖來描 述這些接口。4.3.X （接口的項目唯一的標識符）本條（從4.3.2開始）應通過項目唯一的標識符來標識接口，應簡要地標識接口 實體，根據(jù)需要可分條描述單方或雙方接口實體的特性。如果一指定的接口實體未 包含在本設計說明中（例如，一個外部系統(tǒng)），而描述接口實體需要提到其接口特性 時，這些特性應作為假設予以陳述、或以“當未涵蓋的實體這樣做時，所指定的 實體將”的形式描述。本條可引用其他文檔（例如數(shù)據(jù)字典、協(xié)議標準、用戶

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

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

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

15、）傳輸服務，包括:優(yōu)先級和等級；8）安全性/保密性考慮，如：加密、用戶鑒別、隔離和審核。f）接口實體用于接口的協(xié)議的特征，如：1）項目唯一的標識符；2）協(xié)議的優(yōu)先級別/層次；3）打包，包括分段與重組、路由和尋址；4）合法性檢查、錯誤控制和恢復過程；5）同步，包括連接的建立、保持和終止；6）狀態(tài)、標識和其他報告特性。g）其他特征，例如接口實體的物理兼容性（尺寸、公差、負荷、電壓和接插件 的兼容性等）。5 CSCI詳細設計5.X （軟件單元的項目唯一的標識符，或者一組軟件單元的標識符）本條應通過項目唯一的標識符來標識軟件單元，并對該單元進行說明。（若適用） 該說明應包括下列信息。本條也可以指定一組

16、軟件單元，然后再分小條對它們分別 進行標識和說明，包含其他軟件單元的軟件單元可引用那些軟件單元的說明，而無 需在此重復。a）（若有）單元設計決策，例如所使用的算法（如果此前尚未選定）。b）該軟件單元設計中的任何約束、限定或非常規(guī)特征。c）如果使用的編程語言不同于該CSCI所指定的語言，則應指出并說明使用它的理由。d）如果該軟件單元包含過程性命令或由過程性命令組成（例如數(shù)據(jù)庫管理系統(tǒng) （DBMS）中用于定義表單和報表的菜單選擇，用于數(shù)據(jù)庫訪問和操縱的在線 DBMS查詢，用于代碼自動生成的圖形用戶接口 3口）構造器的輸入，操作系 統(tǒng)的命令或SheIl腳本），應列出這些過程性命令，并引用解釋它們的用戶 手冊或其他文擋。e）如果該軟件單元包含、接收或輸出數(shù)據(jù)，（若適用）應對它的輸入、輸出及其 他數(shù)據(jù)元素和數(shù)據(jù)元素組合體進行說明。本文檔的4.3.X條提供了（若適用） 應包括的主題。軟件單元的局部數(shù)據(jù)應與軟件單元的輸入或輸出數(shù)據(jù)分開來 描述。如果該軟件單元是一個數(shù)據(jù)庫，應引用相應的數(shù)據(jù)庫設計說明；接口 特性可以在這里提供、也可以引用第4章或相應的接口設計說明。f）如果該軟竹單元包含邏輯，則給出該軟件單元所用到的邏輯，（若適用）應包 括：1）該軟件單元執(zhí)行啟動時，其內(nèi)部起作用的條件。2）將控制傳遞給其他軟件單元的條件。3）對每個輸入的響應以及響應時間，包括數(shù)據(jù)轉換、重命名以及數(shù)