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

1、軟件開發(fā)文檔模板1引言1.1 編寫目的1.2 背景1.3 定義1.4 參考資料2總體設計2.1 需求規(guī)定2.2 運行環(huán)境2.3 基本設計概念和處理流程2.4 結構2.5 功能器求與程序的關系2.6 人工處理過程2.7 尚未問決的問題3接口設計3.1 用戶接口3.2 外部接口3.3 內(nèi)部接口4運行設計4.1 運行模塊組合4.2 運行控制4.3 運行時間5系統(tǒng)數(shù)據(jù)結構設計5.1 邏輯結構設計要點5.2 物理結構設計要點5.3 數(shù)據(jù)結構與程序的關系6系統(tǒng)出錯處理設計6.1 出錯信息6.2 補救措施6.3 系統(tǒng)維護設計*2、ISO9001標準文檔模版第1章引言1.1 編寫目的1.2 術語1.3 參考文

2、獻第2章系統(tǒng)概述2.1 系統(tǒng)說明2.2 系統(tǒng)任務2.2.1 系統(tǒng)目標2.2.2 運行環(huán)境2.2.3 與其它系統(tǒng)關系2.3 需求規(guī)定2.3.1 功能需求2.3.2 性能需求2.3.3 數(shù)據(jù)要求2.3.4 其它第3章總體設計3.1 系統(tǒng)物理結構3.1.1 系統(tǒng)流程圖3.1.2 設備清單3.2 軟件結構圖3.2.1 模塊結構圖3.2.2 模塊清單第4章模塊功能描述4.1 模塊1 （標識符） 功能4.2 模塊2 （標識符）功能第5章接口設計5.1 用戶界面5.2 硬件接口5.3 軟件接口5.4 通信接口第6章數(shù)據(jù)結構設計6.1 數(shù)據(jù)Z勾1（標識符）6.1.1 結構屬性6.1.2 邏輯結構6.1.3 物

3、理結構6.1.4 數(shù)據(jù)元素6.2 數(shù)據(jù)Z勾2（標識符）第7章運行設計7.1 運行17.1.1 運行模塊組合運行名稱7.1.2 運行控制操作7.1.3 運行時間7.2 運行2第8章系統(tǒng)安全8.1 系統(tǒng)安全8.2 數(shù)據(jù)安全8.3 后備與恢復8.4 出錯處理8.5 計算機病毒的防治措施第9章功能需求、數(shù)據(jù)結構和模塊9.1 功能需求與模塊關系9.2 數(shù)據(jù)結構與模塊關系*概要設計說明書1 引言1.1 寫目的：闡明編寫概要設計說明書的目的，指明讀者對象。1.2 項目背景：應包括 項目的委托單位、開發(fā)單位和主管部門 該軟件系統(tǒng)與其他系統(tǒng)的關系。1.3 定義：列出本文檔中所用到的專門術語的定義和縮寫詞的愿意。

4、1.4 參考資料： 列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源 項目經(jīng)核準的計劃任務書、合同或上級機關的批文；項目開發(fā)計劃；需求規(guī)格說 明書；測試計劃（初稿）；用戶操作手冊 文檔所引用的資料、采用的標準或規(guī)范。2 任務概述2.1 目標2.2 需求概述2.3 條件與限制3 總體設計3.1 總體結構和模塊外部設計3.2 功能分配：表明各項功能與程序結構的關系。4 接口設計4.1 外部接口：包括用戶界面、軟件接口與硬件接口。4.2 內(nèi)部接口：模塊之間的接口。5 數(shù)據(jù)結構設計6 邏輯結構設計所有文檔的統(tǒng)一封面格式如下頁所示。7 物理結構設計8 數(shù)據(jù)結構與程序的關系9 運行設計9.1

5、運行模塊的組合9.2 運行控制9.3 運行時間10 出錯處理設計10.1 出錯輸出信息10.2 出錯處理對策：如設置后備、性能降級、恢復及再啟動等。11 安全保密設計12 維護設計說明為方便維護工作的設施，如維護模塊等。*自己以前還保留了一份，四份，不盡相同“概要設計說明書”編寫規(guī)范軟件的概要設計又稱為軟件系統(tǒng)（程序系統(tǒng)）的設計，本文件應說明軟件系統(tǒng) 即程序系統(tǒng)設計的總體考慮，包括系統(tǒng)的基本處理流程、軟件系統(tǒng)的組織結構、模塊劃分、 功能分配、數(shù)據(jù)結構、接口、運行、出錯處理和系統(tǒng)維護等方面的設計，為詳細設計提供基礎。1 引言1.1 編寫目的說明編寫本設計說明書的目的，指出預期的讀者。1.2 背景

6、a. 說明待開發(fā)軟件系統(tǒng)的名稱。b. 列出開發(fā)此軟件系統(tǒng)的提出者、開發(fā)者、和用戶。1.3 基線說明本系統(tǒng)設計的設計基線。1.4 范圍說明本設計說明書所涉及的設計內(nèi)容范圍。1.5 定義列出本設計說明書中用到的專門術語和外文字母組詞的原詞組。1.6 參考資料a. 屬于項目的其他已發(fā)表的文件；b. 本設計說明書中引用到的文件、資料，包括所用到的軟件開發(fā)標準。列出這些文件資料的標題、編號、發(fā)表日期、出版單位和查找來源。2 總體設計2.1 概述2.1.1 需求規(guī)定說明本系統(tǒng)主要的輸入、處理、輸出的功能和性能要求等。2.2.2運行環(huán)境說明本系統(tǒng)運行的硬件環(huán)境和支持環(huán)境。2.2 設計2.2.1 設計構思說明

7、對本系統(tǒng)設計的構思、采用的關鍵技術、主要算法和關鍵數(shù)據(jù)結構。2.2.2 系統(tǒng)流程a. 用流程圖示出本系統(tǒng)的主要控制流程和處理流程；b. 用流程圖示出本系統(tǒng)主要的數(shù)據(jù)通路，并說明處理的主要階段。2.2.3 結構設計a. 系統(tǒng)元素確定本系統(tǒng)的元素及其功能，用一覽表說明本系統(tǒng)的系統(tǒng)元素（各層模塊、 子程序、公用程序等）的劃分，按層次給出它們的標識符和功能。b. 系統(tǒng)層次結構用框圖分層次地給出各個系統(tǒng)元素之間的控制和被控制的關系。2.2.4 功能需求與程序的關系用功能需求與程序的矩陣圖表形式，示出各項功能的實現(xiàn)與各系統(tǒng)元素之間的分配關系。系統(tǒng)數(shù)據(jù)結構設計3.1 數(shù)據(jù)結構列出本系統(tǒng)所使用的主要數(shù)據(jù)結構，

8、包括名稱、標識符及數(shù)據(jù)項等。3.2 數(shù)據(jù)結構與系統(tǒng)元素之間的關系用數(shù)據(jù)結構與系統(tǒng)元素之間的矩陣圖表形式，示出各個數(shù)據(jù)結構 與訪問這些數(shù)據(jù)結構的系統(tǒng)元素之間的關系。4接口設計1.1 用戶接口說明本系統(tǒng)向用戶提供的命令、語法結構及系統(tǒng)回答信息等。1.2 外部接口說明本系統(tǒng)的軟件同硬件和支持軟件之間的接口。1.3 內(nèi)部接口說明本系統(tǒng)內(nèi)部相關模塊之間的接口。5 運行設計5.1 系統(tǒng)初始化說明本系統(tǒng)初始化過程。5.2 運行模塊組合說明本系統(tǒng)每項外界運行需經(jīng)過哪些內(nèi)部模塊的組合和支持軟件。5.3 運行控制說明每項外界運行的控制方式、方法和操作步驟。5.4 運行時間說明每項運行模塊組合預計占用各種資源的時間

9、。5.5 運行安全說明系統(tǒng)安全運行的控制。6 信息結構設計（當有相關需求或軟件規(guī)格定義有要求時）按邏輯結構和物理結構給出本軟件有關信息的設計要點。6.1 邏輯結構設計6.1.1 圖形設計6.1.2 中文（包括單個漢字、短語、詞組。）設計6.2 物理結構設計6.2.1 圖形設計6.2.2 中文（包括單個漢字、短語、詞組。）設計6.3 信息結構與程序的關系用信息結構與系統(tǒng)元素之間的矩陣圖表形式，示出各個信息結構與訪問這些信息 結構的系統(tǒng)元素之間的關系。7出錯處理和維護7.1 出錯信息用一覽表列出本系統(tǒng)各種可能出錯或故障的信息形式及其含義。7.2 補救措施說明系統(tǒng)故障出現(xiàn)后可能采取的變通措施，包括：a. 后備技術一一當系統(tǒng)原始數(shù)據(jù)一旦丟失時，啟用副本的建立和啟動技術；b. 降效技術一一使用另一效率稍低的方法以求得所需結果的某些部份，如手工操作和人工記錄數(shù)據(jù)；c.恢復及再啟動技術一一讓系統(tǒng)從故障點恢復執(zhí)行或系統(tǒng)從新啟動運行的方法等。7.3系統(tǒng)維護說明專門安排用于系統(tǒng)檢測與維護的檢測點和系統(tǒng)檢測維護的專用模塊等。 尚待解決的問題說明本設計中尚未解決而系統(tǒng)完成之前應該解決的問題。附加說明：*