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

1、項(xiàng)目名稱 設(shè)計(jì)說明書V1.0（版本號）擬 制 人 審 核 人 批 準(zhǔn) 人 年月日設(shè)計(jì)說明書1引言1.1 編寫目的說明編寫這份設(shè)計(jì)說明書的目的，指出預(yù)期的讀者。1.2 背景a. 待開發(fā)軟件系統(tǒng)的名稱； b. 列出本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶。 1.3 定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.4 參考資料列出有關(guān)的參考資料。 2總體設(shè)計(jì)2.1 需求規(guī)定說明對本系統(tǒng)的主要的輸入輸出項(xiàng)目、處理的功能性能要求。包括2.1.1 系統(tǒng)功能2.1.2 系統(tǒng)性能2.1.2.1 精度2.1.2.2 時(shí)間特性要求2.1.2.4 可靠性2.1.2.5 靈活性輸入輸出要求數(shù)據(jù)管理能力要求2

2、.1.5 故障處理要求2.1.6 其他專門要求2.2 運(yùn)行環(huán)境簡要地說明對本系統(tǒng)的運(yùn)行環(huán)境的規(guī)定。2.2.1 設(shè)備列出運(yùn)行該軟件所需要的硬設(shè)備。說明其中的新型設(shè)備及其專門功能。2.2.2 支持軟件列出支持軟件，包括要用到的操作系統(tǒng)、編譯（或匯編）程序、測試支持軟件等。223 接口說明該系統(tǒng)同其他系統(tǒng)之間的接口、數(shù)據(jù)通信協(xié)議等控制說明控制該系統(tǒng)的運(yùn)行的方法和控制信號，并說明這些控制信號的來源。2.3基本設(shè)計(jì)概念和處理流程說明本系統(tǒng)的基本設(shè)計(jì)概念和處理流程，盡量使用圖表的形式。2.4結(jié)構(gòu)給出系統(tǒng)結(jié)構(gòu)總體框圖（包括軟件、硬件結(jié)構(gòu)框圖），說明本系統(tǒng)的各模塊的劃分，扼要說明每個(gè)系統(tǒng)模塊的標(biāo)識符和功能，分

3、層次地給出各模塊之間的控制與被控制關(guān)系。2.5功能需求與系統(tǒng)模塊的關(guān)系本條用一張矩陣圖說明各項(xiàng)功能需求的實(shí)現(xiàn)同各模塊的分配關(guān)系。系統(tǒng)模塊1系統(tǒng)模塊2系統(tǒng)模塊m功能需求1V功能需求2V門功能需求nVV2.6人工處理過程說明在本系統(tǒng)的工作過程中不得不包含的人工處理過程。2.7 尚未解決的問題說明在概要設(shè)計(jì)過程中尚未解決而設(shè)計(jì)者認(rèn)為在系統(tǒng)完成之前必須解決的各個(gè)問題。3. 系統(tǒng)的結(jié)構(gòu)給出系統(tǒng)的結(jié)構(gòu)框圖，包括軟件結(jié)構(gòu)、硬件結(jié)構(gòu)框圖。用一系列圖表列出系統(tǒng)內(nèi)的每 個(gè)模塊的名稱、標(biāo)識符和它們之間的層次結(jié)構(gòu)關(guān)系。 4模塊 1（標(biāo)識符）設(shè)計(jì)說明從本章開始，逐個(gè)地給出各個(gè)層次中的每個(gè)模塊的設(shè)計(jì)考慮。以下給出的提綱是

4、針對一般情況的。 對于一個(gè)具體的模塊， 尤其是層次比較低的模塊或子程序， 其很多條目的內(nèi)容 往往與它所隸屬的上一層模塊的對應(yīng)條目的內(nèi)容相同， 在這種情況下， 只要簡單地說明這一 點(diǎn)即可。 4.1 模塊描述 給出對該基本模塊的簡要描述，主要說明安排設(shè)計(jì)本模塊的目的意義，并且，還要說明本模塊的特點(diǎn)。 4.2 功能說明該基本模塊應(yīng)具有的功能。 4.3 性能說明對該模塊的全部性能要求。 4.4 輸入項(xiàng)給出對每一個(gè)輸入項(xiàng)的特性。 4.5 輸出項(xiàng)給出對每一個(gè)輸出項(xiàng)的特性。 4.6 設(shè)計(jì)方法（算法）對于軟件設(shè)計(jì)，應(yīng)詳細(xì)說明本程序所選取用的算法，具體的計(jì)算公式及計(jì)算步驟。對于硬件設(shè)計(jì)，應(yīng)詳細(xì)說明本模塊的設(shè)計(jì)原

5、理、元器件的選取、各元器件的邏輯關(guān)系，所需要的各種協(xié)議等。 4.7 流程邏輯用圖表輔以必要的說明來表示本模塊的邏輯流程。4.8 接口說明本模塊與其它相關(guān)模塊間的邏輯連接方式，說明涉及到的參數(shù)傳遞方式。4.9 存儲分配根據(jù)需要，說明本模塊的存儲分配。4.10 注釋設(shè)計(jì)說明安排的程序注釋。 4.11 限制條件說明本模塊在運(yùn)行使用中所受到的限制條件。4.12 測試計(jì)劃說明對本模塊進(jìn)行單體測試的計(jì)劃，包括對測試的技術(shù)要求、輸入數(shù)據(jù)、預(yù)期結(jié)果、進(jìn)度安排、人員職責(zé)、設(shè)備條件、驅(qū)動程序及樁模塊等的規(guī)定。 4.13 尚未解決的問題說明在本模塊的設(shè)計(jì)中尚未解決而設(shè)計(jì)者認(rèn)為在系統(tǒng)完成之前應(yīng)解決的問題。5模塊 2（

6、標(biāo)識符）設(shè)計(jì)說明用類似第 4 條的方式，說明第 2 個(gè)模塊乃至第 N 個(gè)模塊的設(shè)計(jì)考慮。 5接口設(shè)計(jì)5.1 用戶接口說明將向用戶提供的命令和它們的語法結(jié)構(gòu)，以及相應(yīng)的回答信息。說明提供給用戶操作的硬件控制面板的定義。5.2 外部接口說明本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之間的接口、本系統(tǒng)與各支持系 統(tǒng)之間的接口關(guān)系。 5.3 內(nèi)部接口說明本系統(tǒng)之內(nèi)的各個(gè)系統(tǒng)元素之間的接口的安排。6運(yùn)行設(shè)計(jì)6.1 運(yùn)行模塊組合說明對系統(tǒng)施加不同的外界運(yùn)行控制時(shí)所引起的各種不同的運(yùn)行模塊組合，說明每種運(yùn)行所歷經(jīng)的內(nèi)部模塊的支持軟件。 6.2運(yùn)行控制說明每一種外界的運(yùn)行控制的方式方法和操作步驟。6.3運(yùn)行時(shí)

7、間說明每種運(yùn)行模塊組合將占用各種資源的時(shí)間。7.系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)不涉及軟件設(shè)計(jì)可不包含 7.1邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn)給出本系統(tǒng)內(nèi)軟件所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)的名稱、標(biāo)識符以及它們之中每個(gè)數(shù)據(jù)項(xiàng)、 記錄、文卷和系的標(biāo)識、定義、長度及它們之間的層次的或表格的相互關(guān)系。7.2物理結(jié)構(gòu)設(shè)計(jì)要點(diǎn)給出本系統(tǒng)內(nèi)軟件所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)中的每個(gè)數(shù)據(jù)項(xiàng)的存儲要求，訪問方法、存 取單位、存取的物理關(guān)系、設(shè)計(jì)考慮和保密條件。7.3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系說明各個(gè)數(shù)據(jù)結(jié)構(gòu)與訪問這些數(shù)據(jù)結(jié)構(gòu)的各個(gè)程序之間的對應(yīng)關(guān)系。程序1程序2程序m數(shù)據(jù)結(jié)構(gòu)1V數(shù)據(jù)結(jié)構(gòu)2VV111數(shù)據(jù)結(jié)構(gòu)nV8系統(tǒng)出錯(cuò)處理設(shè)計(jì)8.1 出錯(cuò)信息用一覽表的方式說明每種可能的出錯(cuò)或故障情況出現(xiàn)時(shí)，系統(tǒng)輸出信息的形式、含意 及處理方法。 8.2 補(bǔ)救措施說明故障出現(xiàn)后可能采取的變通措施。包括：a. 后備技術(shù) 說明準(zhǔn)備采用的后備技術(shù)， 當(dāng)原始系統(tǒng)數(shù)據(jù)萬一丟失時(shí)啟用的副本的建立和 啟動的技術(shù)， 例如周期性地把磁盤信息記錄到磁帶上去就是對于磁盤媒體的一種后備技 術(shù)。 b. 降效技術(shù) 說明準(zhǔn)備采用的后備技術(shù)， 使用另一個(gè)效率稍低的系統(tǒng)或方法來求得所需結(jié) 果的某些部分，例如一個(gè)自動系統(tǒng)的降效技術(shù)可以是手工操作和數(shù)據(jù)的人工記錄。 c. 恢復(fù)及再啟動技術(shù) 說明將使用的恢復(fù)再啟動技術(shù)， 使軟件從故障點(diǎn)恢