軟件設(shè)計說明書格式 附設(shè)計自查單全套

軟件設(shè)計說明書格式附設(shè)計自查單引言1.1編寫目的說明編寫這份詳細(xì)設(shè)計說明書的目的，指出預(yù)期的讀者范圍。1.2背景說明說明：1.待開發(fā)的軟件系統(tǒng)的名稱；2.列出本項目的任務(wù)提出者、開發(fā)者、用戶以及將運(yùn)行該項軟件的單位。1.3定義列出本文件中用到的專門術(shù)語的定義和縮寫詞的原詞組。1.4參考資料列出要用到的參考資料，如：1.本項目的經(jīng)核準(zhǔn)的計劃任務(wù)書或合同、上級機(jī)關(guān)的批文；2.屬于本項目的其他已發(fā)表的文件；3.本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。注意所有新章?lián)Q頁。圖名居中，位于圖下方，兩級標(biāo)號：章節(jié)號-序列號。每章序號升序排列。表的要求如下：表1-1××××××××表名居中，位于表上方，兩級標(biāo)號：章節(jié)號-序列號。每章序號升序排列。非異性表格的一律使用三線表。如表格換頁請拆分表格后加續(xù)表表頭。全文關(guān)于圖表的要求同上。2總體設(shè)計2.1需求規(guī)定說明對本系統(tǒng)的主要的輸入輸出項目、處理的功能性能要求2.2運(yùn)行環(huán)境簡要地說明對本系統(tǒng)的運(yùn)行環(huán)境（包括硬件環(huán)境和支持環(huán)境）的規(guī)定2.3基本設(shè)計概念和處理流程說明本系統(tǒng)的基本設(shè)計概念和處理流程，盡量使用圖表的形式。2.4結(jié)構(gòu)設(shè)計2.4.1結(jié)構(gòu)用一覽表及框圖的形式說明本系統(tǒng)的系統(tǒng)元素（各層模塊、子程序、公用程序等）的劃分，扼要說明每個系統(tǒng)元素的標(biāo)識符和功能，分層次地給出各元素之間的控制與被控制關(guān)系。2.4.2功能需求與程序的關(guān)系本條用一張如下的矩陣圖說明各項功能需求的實(shí)現(xiàn)同各塊程序的分配關(guān)系：程序1程序2……程序n功能需求1√功能需求2√……功能需求n√√2.4.3人工處理過程說明在本軟件系統(tǒng)的工作過程中不得不包含的人工處理過程（如果有的話）。2.4.4尚未問決的問題說明在概要設(shè)計過程中尚未解決而設(shè)計者認(rèn)為在系統(tǒng)完成之前必須解決的各個問題。2.5接口設(shè)計2.5.1用戶接口說明將向用戶提供的命令和它們的語法結(jié)構(gòu)，以及軟件的回答信息。2.5.2外部接口說明本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之間的接口、本系統(tǒng)與各支持軟件之間的接口關(guān)系。2.5.3內(nèi)部接口說明本系統(tǒng)之內(nèi)的各個系統(tǒng)元素之間的接口的安排。2.6其它專門要求3數(shù)據(jù)庫設(shè)計3.1概念結(jié)構(gòu)設(shè)計[說明本數(shù)據(jù)庫將反映的現(xiàn)實(shí)世界中的實(shí)體、屬性和它們之間的關(guān)系等的原始數(shù)據(jù)形式，包括各數(shù)據(jù)項、記錄、系、文卷的標(biāo)識符、定義、類型、度量單位和值域，建立本數(shù)據(jù)庫的每一幅用戶視圖。]3.2邏輯結(jié)構(gòu)設(shè)計[說明把上述原始數(shù)據(jù)進(jìn)行分解、合并后重新組織起來的數(shù)據(jù)庫全局邏輯結(jié)構(gòu)。]3.3物理結(jié)構(gòu)設(shè)計[建立系統(tǒng)程序員視圖。]3.3數(shù)據(jù)字典設(shè)計[對數(shù)據(jù)庫設(shè)計中涉及到的各種項目一般要建立起數(shù)據(jù)字典，以說明它們的標(biāo)識符、同義名及有關(guān)信息。]3.4安全保密設(shè)計[說明在數(shù)據(jù)庫的設(shè)計中，將如何通過區(qū)分不同的訪問者、不同的訪問類型和不同的數(shù)據(jù)對象，進(jìn)行分別對待而獲得的數(shù)據(jù)庫安全保密的設(shè)計考慮。]

4系統(tǒng)出錯處理設(shè)計4.1出錯信息用一覽表的方式說朗每種可能的出錯或故障情況出現(xiàn)時，系統(tǒng)輸出信息的形式、含意及處理方法。4.2補(bǔ)救措施說明故障出現(xiàn)后可能采取的變通措施，包括：1.后備技術(shù)說明準(zhǔn)備采用的后備技術(shù)，當(dāng)原始系統(tǒng)數(shù)據(jù)萬一丟失時啟用的副本的建立和啟動的技術(shù)，例如周期性地把磁盤信息記錄到磁帶上去就是對于磁盤媒體的一種后備技術(shù)；2.降效技術(shù)說明準(zhǔn)備采用的后備技術(shù)，使用另一個效率稍低的系統(tǒng)或方法來求得所需結(jié)果的某些部分，例如一個自動系統(tǒng)的降效技術(shù)可以是手工操作和數(shù)據(jù)的人工記錄；恢復(fù)及再啟動技術(shù)說明將使用的恢復(fù)再啟動技術(shù)，使軟件從故障點(diǎn)恢復(fù)執(zhí)行或使軟件從頭開始重新運(yùn)行的方法。[備份和數(shù)據(jù)恢復(fù)技術(shù)]4.3.系統(tǒng)維護(hù)設(shè)計說明為了系統(tǒng)維護(hù)的方便而在程序內(nèi)部設(shè)計中作出的安排，包括在程序中專門安排用于系統(tǒng)的檢查與維護(hù)的檢測點(diǎn)和專用模塊。各個程序之間的對應(yīng)關(guān)系，可采用如下的矩陣圖的形式；

5程序模塊1設(shè)計說明從本章開始，逐個地給出各個層次中的每個程序的設(shè)計考慮。以下給出的提綱是針對一般情況的。對于一個具體的模塊，尤其是層次比較低的模塊或子程序，其很多條目的內(nèi)容往往與它所隸屬的上一層模塊的對應(yīng)條目的內(nèi)容相同，在這種情況下，只要簡單地說明這一點(diǎn)即可。5.1程序描述給出對該程序的簡要描述，主要說明安排設(shè)計本程序的目的意義，并且，還要說明本程序的特點(diǎn)（如是常駐內(nèi)存還是非常駐？是否子程序？有無覆蓋要求？是順序處理還是并發(fā)處理等）。5.2功能說明該程序應(yīng)具有的功能，可采用IPO圖（即輸入一處理一輸出圖）的形式。5.3算法詳細(xì)說明本程序所選用的算法，具體的計算公式和計算步驟。用圖表（例如流程圖、判定表等）輔以必要的說明來表示本程序的邏輯流程。5.4注釋設(shè)計說明準(zhǔn)備在本程序中安排的注釋，如：1.加在模塊首部的注釋；2.加在各分枝點(diǎn)處的注釋；3.對各變量的功能、范圍、缺省條件等所加的注釋；對使用的邏輯所加的注釋等等。5.5測試計劃說明對本程序進(jìn)行單體測試的計劃，包括對測試的技術(shù)要求、輸入數(shù)據(jù)、預(yù)期結(jié)果、進(jìn)度安排、人員職責(zé)、設(shè)備條件驅(qū)動程序及樁模塊等的規(guī)定。6程序模塊2設(shè)計說明用類似第5章的方式，說明第2個程序模塊乃至第N個程序模塊的設(shè)計考慮。自己根據(jù)需要增加章節(jié)。設(shè)計自查單設(shè)計自查單設(shè)計自查單項目名稱項目經(jīng)理活動名稱自查人檢查日期活動對象統(tǒng)計結(jié)果合格不合格未檢查不適用共計結(jié)論備注00000序號檢查內(nèi)容檢查結(jié)果補(bǔ)充信息概要設(shè)計1設(shè)計方案是否滿足產(chǎn)品需求與用戶需求的功能、性能及安全性等所有要求？2設(shè)計方案的架構(gòu)設(shè)計是否簡單而清晰？3是否盡可能避免了模塊（或子系統(tǒng)）間的相關(guān)性？4是否對處理流程、總體結(jié)構(gòu)與模塊、功能與模塊的關(guān)系進(jìn)行了清楚的描述？5是否對外部用戶、軟、硬件接口進(jìn)行了清晰描述？對內(nèi)部模塊間接口進(jìn)行了清楚描述？6如果有移植的需求，那么設(shè)計中是否對移植性作了充分的考慮？7如果采用數(shù)據(jù)庫技術(shù)，數(shù)據(jù)庫設(shè)計是否與其了他設(shè)計內(nèi)容一致？8設(shè)計方案是否考慮了軟件的擴(kuò)展性與維護(hù)性？9是否進(jìn)行了出錯信息與出錯處理的設(shè)計？詳細(xì)設(shè)計1設(shè)計方案是否滿足產(chǎn)品需求與用戶需求的功能、性能及安全性等所有要求？2是否詳細(xì)考慮了編碼時的代碼復(fù)用問題？3是否規(guī)定了設(shè)計與編碼時的命名規(guī)則？4設(shè)計是