軟件開發(fā)文檔模板

1、軟件開發(fā)文檔模板1引言編寫目的背景定義參考資料2總體設(shè)計需求規(guī)定運行環(huán)境基本設(shè)計概念和處理流程結(jié)構(gòu)功能器求與程序的關(guān)系人工處理過程尚未問決的問題設(shè)計用戶接口外部接口內(nèi)部接口4運行設(shè)計運行模塊組合運行控制運行時間5系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計邏輯結(jié)構(gòu)設(shè)計要點物理結(jié)構(gòu)設(shè)計要點數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系6系統(tǒng)出錯處理設(shè)計出錯信息補救措施系統(tǒng)維護設(shè)計*2、 HYPERLINK /bzgf/bzgf.htm /bzgf/bzgf.htmISO9001標準文檔模版第1章引言編寫目的術(shù)語參考文獻第2章系統(tǒng)概述系統(tǒng)說明系統(tǒng)任務(wù)系統(tǒng)目標運行環(huán)境與其它系統(tǒng)關(guān)系需求規(guī)定功能需求性能需求數(shù)據(jù)要求其它第3章總體設(shè)計系統(tǒng)物理結(jié)構(gòu)系統(tǒng)流程圖

2、設(shè)備清單軟件結(jié)構(gòu)圖模塊結(jié)構(gòu)圖模塊清單第4章模塊功能描述模塊1（標識符）功能模塊2（標識符）功能第5章接口設(shè)計用戶界面硬件接口軟件接口通信接口第6章數(shù)據(jù)結(jié)構(gòu)設(shè)計數(shù)據(jù)結(jié)構(gòu)1（標識符）結(jié)構(gòu)屬性邏輯結(jié)構(gòu)物理結(jié)構(gòu)數(shù)據(jù)元素數(shù)據(jù)結(jié)構(gòu)2（標識符）第7章運行設(shè)計運行1運行模塊組合運行名稱運行控制操作運行時間運行2第8章系統(tǒng)安全系統(tǒng)安全數(shù)據(jù)安全后備與恢復(fù)出錯處理計算機病毒的防治措施第9章功能需求、數(shù)據(jù)結(jié)構(gòu)和模塊功能需求與模塊關(guān)系數(shù)據(jù)結(jié)構(gòu)與模塊關(guān)系個個個個個個個個個個個個個個個個個個個個個個個個個個個個個個個個個個個個個個個個 HYPERLINK /yyal/yyal9.htm /yyal/yyal9.htm概要設(shè)

3、計說明書引言寫目的：闡明編寫概要設(shè)計說明書的目的，指明讀者對象。項目背景：應(yīng)包括項目的委托單位、開發(fā)單位和主管部門該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。定義：列出本文檔中所用到的專門術(shù)語的定義和縮寫詞的愿意。參考資料：列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源項目經(jīng)核準的計劃任務(wù)書、合同或上級機關(guān)的批文；項目開發(fā)計劃；需求規(guī)格說明書；測試計劃（初稿）；用戶操作手冊文檔所引用的資料、采用的標準或規(guī)范。任務(wù)概述目標需求概述條件與限制總體設(shè)計總體結(jié)構(gòu)和模塊外部設(shè)計功能分配：表明各項功能與程序結(jié)構(gòu)的關(guān)系。接口設(shè)計外部接口：包括用戶界面、軟件接口與硬件接口。內(nèi)部接口：模塊之間的接口。數(shù)據(jù)結(jié)構(gòu)設(shè)計

4、邏輯結(jié)構(gòu)設(shè)計所有文檔的統(tǒng)一封面格式如下頁所示。物理結(jié)構(gòu)設(shè)計數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系運行設(shè)計運行模塊的組合運行控制運行時間出錯處理設(shè)計出錯輸出信息出錯處理對策：如設(shè)置后備、性能降級、恢復(fù)及再啟動等。安全保密設(shè)計維護設(shè)計說明為方便維護工作的設(shè)施，如維護模塊等。*自己以前還保留了一份，四份，不盡相同“概要設(shè)計說明書”編寫規(guī)范軟件的概要設(shè)計又稱為軟件系統(tǒng)（程序系統(tǒng)）的設(shè)計，本文件應(yīng)說明軟件系統(tǒng)即程序系統(tǒng)設(shè)計的總體考慮，包括系統(tǒng)的基本處理流程、軟件系統(tǒng)的組織結(jié)構(gòu)、模塊劃分、功能分配、數(shù)據(jù)結(jié)構(gòu)、接口、運行、出錯處理和系統(tǒng)維護等方面的設(shè)計，為詳細設(shè)計提供基礎(chǔ)。引言編寫目的說明編寫本設(shè)計說明書的目的，指出預(yù)期的讀

5、者。背景說明待開發(fā)軟件系統(tǒng)的名稱。列出開發(fā)此軟件系統(tǒng)的提出者、開發(fā)者、和用戶?；€說明本系統(tǒng)設(shè)計的設(shè)計基線。范圍說明本設(shè)計說明書所涉及的設(shè)計內(nèi)容范圍。定義列出本設(shè)計說明書中用到的專門術(shù)語和外文字母組詞的原詞組。參考資料屬于項目的其他已發(fā)表的文件；本設(shè)計說明書中引用到的文件、資料，包括所用到的軟件開發(fā)標準。列出這些文件資料的標題、編號、發(fā)表日期、出版單位和查找來源?？傮w設(shè)計概述需求規(guī)定說明本系統(tǒng)主要的輸入、處理、輸出的功能和性能要求等。運行環(huán)境說明本系統(tǒng)運行的硬件環(huán)境和支持環(huán)境。設(shè)計設(shè)計構(gòu)思說明對本系統(tǒng)設(shè)計的構(gòu)思、采用的關(guān)鍵技術(shù)、主要算法和關(guān)鍵數(shù)據(jù)結(jié)構(gòu)。系統(tǒng)流程用流程圖示出本系統(tǒng)的主要控制流程和

6、處理流程；用流程圖示出本系統(tǒng)主要的數(shù)據(jù)通路，并說明處理的主要階段。結(jié)構(gòu)設(shè)計系統(tǒng)元素確定本系統(tǒng)的元素及其功能，用一覽表說明本系統(tǒng)的系統(tǒng)元素（各層模塊、子程序、公用程序等）的劃分，按層次給出它們的標識符和功能。系統(tǒng)層次結(jié)構(gòu)用框圖分層次地給出各個系統(tǒng)元素之間的控制和被控制的關(guān)系。功能需求與程序的關(guān)系用功能需求與程序的矩陣圖表形式，示出各項功能的實現(xiàn)與各系統(tǒng)元素之間的分配關(guān)系。系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計數(shù)據(jù)結(jié)構(gòu)列出本系統(tǒng)所使用的主要數(shù)據(jù)結(jié)構(gòu)，包括名稱、標識符及數(shù)據(jù)項等。數(shù)據(jù)結(jié)構(gòu)與系統(tǒng)元素之間的關(guān)系用數(shù)據(jù)結(jié)構(gòu)與系統(tǒng)元素之間的矩陣圖表形式，示出各個數(shù)據(jù)結(jié)構(gòu)與訪問這些數(shù)據(jù)結(jié)構(gòu)的系統(tǒng)元素之間的關(guān)系。接口設(shè)計用戶接口說明

7、本系統(tǒng)向用戶提供的命令、語法結(jié)構(gòu)及系統(tǒng)回答信息等。外部接口說明本系統(tǒng)的軟件同硬件和支持軟件之間的接口。內(nèi)部接口說明本系統(tǒng)內(nèi)部相關(guān)模塊之間的接口。運行設(shè)計系統(tǒng)初始化說明本系統(tǒng)初始化過程。運行模塊組合說明本系統(tǒng)每項外界運行需經(jīng)過哪些內(nèi)部模塊的組合和支持軟件。運行控制說明每項外界運行的控制方式、方法和操作步驟。運行時間說明每項運行模塊組合預(yù)計占用各種資源的時間。運行安全說明系統(tǒng)安全運行的控制。信息結(jié)構(gòu)設(shè)計（當(dāng)有相關(guān)需求或軟件規(guī)格定義有要求時）按邏輯結(jié)構(gòu)和物理結(jié)構(gòu)給出本軟件有關(guān)信息的設(shè)計要點。邏輯結(jié)構(gòu)設(shè)計圖形設(shè)計中文（包括單個漢字、短語、詞組。）設(shè)計物理結(jié)構(gòu)設(shè)計圖形設(shè)計中文（包括單個漢字、短語、詞組。

8、）設(shè)計信息結(jié)構(gòu)與程序的關(guān)系用信息結(jié)構(gòu)與系統(tǒng)元素之間的矩陣圖表形式，示出各個信息結(jié)構(gòu)與訪問這些信息結(jié)構(gòu)的系統(tǒng)元素之間的關(guān)系。出錯處理和維護出錯信息用一覽表列出本系統(tǒng)各種可能出錯或故障的信息形式及其含義。補救措施說明系統(tǒng)故障出現(xiàn)后可能采取的變通措施，包括：后備技術(shù)當(dāng)系統(tǒng)原始數(shù)據(jù)一旦丟失時，啟用副本的建立和啟動技術(shù)；降效技術(shù)使用另一效率稍低的方法以求得所需結(jié)果的某些部份，如手工操作和人工記錄數(shù)據(jù)；c.恢復(fù)及再啟動技術(shù)讓系統(tǒng)從故障點恢復(fù)執(zhí)行或系統(tǒng)從新啟動運行的方法等。系統(tǒng)維護說明專門安排用于系統(tǒng)檢測與維護的檢測點和系統(tǒng)檢測維護的專用模塊等。尚待解決的問題說明本設(shè)計中尚未解決而系統(tǒng)完成之前應(yīng)該解決的問題。附加說明：*本規(guī)范根據(jù)國家標準GB/T8566