07軟件設(shè)計(jì)說明書模板

1、份號(hào)：001密級(jí):裝備管理信息系統(tǒng)軟件設(shè)計(jì)說明書XXXX-RSJ-R01.00XXXXXXXX 公司XXXX年XX月XX日輯要頁項(xiàng)目名稱文件名稱項(xiàng)目代號(hào)總頁數(shù)完成單位擬 制簽名與日期職務(wù)或技術(shù)職稱楚金龍校 對(duì)審 核標(biāo) 審批 準(zhǔn)會(huì) 簽摘要：主題詞：文檔修改記錄版本號(hào)修改內(nèi)容描述修改人日期備注 TOC o 1-5 h z 1范圍1標(biāo)識(shí)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級(jí)設(shè)計(jì)決策1 HYPERLINK l bookmark13 o Current Document CSCI體系結(jié)構(gòu)設(shè)計(jì)2 HYPERLINK l bookmark15 o Current Document CSCI 部件2 HYPERLINK l bookmark17 o Current Document 執(zhí)行方案3接口設(shè)計(jì)3接口標(biāo)識(shí)和接口圖3 HYPERLINK l bookmark22 o Current Document .X （接口的項(xiàng)目唯一的標(biāo)識(shí)符）3CSCI詳細(xì)設(shè)計(jì)5 H

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

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

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

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

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

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

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

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

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

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

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

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

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

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