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

1、工程名稱設(shè)計(jì)說(shuō)明書(shū)VI.0版本號(hào)擬制人審核人批準(zhǔn)人年月日頁(yè)腳.設(shè)計(jì)說(shuō)明書(shū)1. 引言1.1 編寫(xiě)目的說(shuō)明編寫(xiě)這份設(shè)計(jì)說(shuō)明書(shū)的目的,指出預(yù)期的讀者.1.2 背景a.待開(kāi)發(fā)軟件系統(tǒng)的名稱；b.列出本工程的任務(wù)提出者、開(kāi)發(fā)者、用戶.1.3 定義列出本文件中用到的專門術(shù)語(yǔ)的定義和外文首字母組詞的原詞組.L4參考資料列出有關(guān)的參考資料.2. 總體設(shè)計(jì)3. 1需求規(guī)定說(shuō)明對(duì)本系統(tǒng)的主要的輸入輸出工程、處理的功能性能要求.包括4. 1.1系統(tǒng)功能5. 1.2系統(tǒng)性能6. 1.2.1精度7. 1.2.2時(shí)間特性要求2.1.2.4可靠性2.1.2.5靈活性2.1.3輸入輸出要求2.1.4數(shù)據(jù)治理水平要求2.1.5

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

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

4、模塊,尤其是層次比擬低的模塊或子程序,其很多條目的容往往與它所隸屬的上一層模塊的對(duì)應(yīng)條目的容相同,在這種情況下,只要簡(jiǎn)單地說(shuō)明這一點(diǎn)即可.4.1 模塊描述給出對(duì)該根本模塊的簡(jiǎn)要描述,主要說(shuō)明安排設(shè)計(jì)本模塊的目的意義,并且,還要說(shuō)明本模塊的特點(diǎn).4.2功能說(shuō)明該根本模塊應(yīng)具有的功能.4.3性能說(shuō)明對(duì)該模塊的全部性能要求.4.4輸入項(xiàng)給出對(duì)每一個(gè)輸入項(xiàng)的特性.4.5輸出項(xiàng)給出對(duì)每一個(gè)輸出項(xiàng)的特性.4.6設(shè)計(jì)方法算法對(duì)于軟件設(shè)計(jì),應(yīng)詳細(xì)說(shuō)明本程序所選取用的算法,具體的計(jì)算公式及計(jì)算步驟.對(duì)于硬件設(shè)計(jì),應(yīng)詳細(xì)說(shuō)明本模塊的設(shè)計(jì)原理、元器件的選取、各元器件的邏輯關(guān)系,所需要的各種協(xié)議等.4.7流程邏輯用圖

5、表輔以必要的說(shuō)明來(lái)表示本模塊的邏輯流程.4.8接口說(shuō)明本模塊與其它相關(guān)模塊間的邏輯連接方式,說(shuō)明涉及到的參數(shù)傳遞方式.4.9存儲(chǔ)分配根據(jù)需要,說(shuō)明本模塊的存儲(chǔ)分配.4.10注釋設(shè)計(jì)說(shuō)明安排的程序注釋.4.11限制條件說(shuō)明本模塊在運(yùn)行使用中所受到的限制條件.4.12測(cè)試方案說(shuō)明對(duì)本模塊進(jìn)行單體測(cè)試的方案,包括對(duì)測(cè)試的技術(shù)要求、輸入數(shù)據(jù)、預(yù)期結(jié)果、進(jìn)度安排、人員責(zé)任、設(shè)備條件、驅(qū)動(dòng)程序及樁模塊等的規(guī)定.4.13尚未解決的問(wèn)題說(shuō)明在本模塊的設(shè)計(jì)未解決而設(shè)計(jì)者認(rèn)為在系統(tǒng)完成之前應(yīng)解決的問(wèn)題.5.模塊2標(biāo)識(shí)符設(shè)計(jì)說(shuō)明用類似第4條的方式,說(shuō)明第2個(gè)模塊乃至第N個(gè)模塊的設(shè)計(jì)考慮.5.接口設(shè)計(jì)5.1用戶接口說(shuō)

6、明將向用戶提供的命令和它們的語(yǔ)法結(jié)構(gòu),以及相應(yīng)的答復(fù)信息.說(shuō)明提供應(yīng)用戶操作的硬件限制面板的定義.5.2外部接口說(shuō)明本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之間的接口、本系統(tǒng)與各支持系統(tǒng)之間的接口關(guān)系.5.3部接口說(shuō)明本系統(tǒng)之的各個(gè)系統(tǒng)元素之間的接口的安排.6.運(yùn)行設(shè)計(jì)6. 1運(yùn)行模塊組合說(shuō)明對(duì)系統(tǒng)施加不同的外界運(yùn)行限制時(shí)所引起的各種不同的運(yùn)行模塊組合,說(shuō)明每種運(yùn)行所歷經(jīng)的部模塊的支持軟件.7. 2運(yùn)行限制說(shuō)明每一種外界的運(yùn)行限制的方式方法和操作步驟.8. 3運(yùn)行時(shí)間說(shuō)明每種運(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)軟件所使

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