概要設計範本

1   軟體開發文件範本   
    
   1引言   
   1.1編寫目的   
   1.2背景   
   1.3定義   
   1.4參考資料   
   2總體設計   
   2.1需求規定   
   2.2運行環境   
   2.3基本設計概念和處理流程   
   2.4結構   
   2.5功能器求與程式的關係   
   2.6人工處理過程   
   2.7尚未問決的問題   
   3介面設計   
   3.1使用者介面   
   3.2外部介面   
   3.3內部介面   
   4運行設計   
   4.1運行模組組合   
   4.2運行控制   
   4.3已耗用時間   
   5系統資料結構設計   
   5.1邏輯結構設計要點   
   5.2物理結構設計要點   
   5.3資料結構與程式的關係   
   6系統出錯處理設計   
   6.1出錯資訊   
   6.2補救措施   
   6.3系統維護設計   
    
    
   ****************************************   
   ISO9001標準文檔模版   
    
   第1章 引言   
   1.1 編寫目的   
   1.2 術語   
   1.3 參考文獻   
   第2章 系統概述   
   2.1 系統說明   
   2.2 系統任務   
   2.2.1 系統目標   
   2.2.2 運行環境   
   2.2.3 與其它系統關係   
   2.3 需求規定   
   2.3.1 功能需求   
   2.3.2 效能需求   
   2.3.3 資料要求   
   2.3.4 其它   
   第3章 總體設計   
   3.1 系統物理結構   
   3.1.1 系統流程圖   
   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章 資料結構設計   
   6.1 資料結構1    （標識符）   
   6.1.1 結構屬性   
   6.1.2 邏輯結構   
   6.1.3 物理結構   
   6.1.4 資料元素   
   6.2 資料結構2    （標識符）   
   第7章 運行設計   
   7.1 運行1   
   7.1.1 運行模組組合運行名稱   
   7.1.2 運行控制操作   
   7.1.3 已耗用時間   
   7.2 運行2   
   第8章 系統安全   
   8.1 系統安全   
   8.2 資料安全   
   8.3 後備與恢複   
   8.4 出錯處理   
   8.5 電腦病毒的防治措施   
   第9章 功能需求、資料結構和模組   
   9.1 功能需求與模組關係   
   9.2 資料結構與模組關係   
    
   ****************************************   

   概要設計說明書     
    
   1    引言     
   1.1    寫目的：闡明編寫概要設計說明書的目的，指明讀者對象。     
   1.2    項目背景：應包括     
   　　●    項目的委託單位、開發單位和主管部門     
   　　●    該軟體系統與其他系統的關係。     
   1.3    定義：列出本文檔中所用到的專門術語的定義和縮寫詞的願意。     
   1.4    參考資料：     
   　　●    列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源     
   　　●項目經核準的計劃任務書、合約或上級機關的批文；項目開發計劃；需求規格說明書；測試計劃（初稿）；使用者操作手冊     
   　　●    文檔所引用的資料、採用的標準或規範。     
   2    任務概述     
   2.1    目標     
   2.2    需求概述     
   2.3    條件與限制     
   3    總體設計     
   3.2    總體結構和模組外部設計     
   3.3    功能分配：表明各項功能與程式結構的關係。     
   4    介面設計     
   4.1    外部介面：包括使用者介面、軟體介面與硬體介面。     
   4.2    內部介面：模組之間的介面。     
   5    資料結構設計     
   6    邏輯結構設計     
   　　所有文檔的統一封面格式如下頁所示。     
   7    物理結構設計     
   8    資料結構與程式的關係     
   9    運行設計     
   9.1    運行模組的組合     
   9.2    運行控制     
   9.3    已耗用時間     
   10    出錯處理設計     
   10.1    出錯輸出資訊     
   10.2    出錯處理對策：如設定後備、效能降級、恢複及再啟動等。     
   11    安全保密設計     
   12    維護設計     
   　　說明為方便維護工作的設施，如維護模組等。   
    
   ****************************************   

    
   “概要設計說明書”編寫規範     
           軟體的概要設計又稱為軟體系統（程式系統）的設計，本檔案應說明軟體系統即程式系統設計的總體考慮，包括系統的基本處理流程、軟體系統的組織圖、模組劃 分、功能分配、資料結構、介面、運行、    出錯處理和系統維護等方面的設計，為詳細設計提供基礎。   
   １    引言   
   1.1      編寫目的   
             說明編寫本設計說明書的目的，指出預期的讀者。   
   1.2      背景   
             a.    說明待開發軟體系統的名稱。   
             b.    列出開發此軟體系統的提出者、開發人員、和使用者。   
   1.3      基準   
             說明本系統設計的設計基準。   
   1.4      範圍   
             說明本設計說明書所涉及的設計內容約制。   
   1.5      定義   
         列出本設計說明書中用到的專門術語和外文字母組詞的原片語。   
   1.6      參考資料   
             a.    屬於項目的其他已發表的檔案；   
             b.    本設計說明書中引用到的檔案、資料，包括所用到的軟體開發標準。   
     列出這些檔案資料的標題、編號、發表日期、出版單位和尋找來源。   
   2      總體設計       
   2.1      概述   
   2.1.1      需求規定   
             說明本系統主要的輸入、處理、輸出的功能和效能要求等。     
   2.2.2      運行環境   
             說明本系統啟動並執行硬體環境和支援環境。   
   2.2      設計   
   2.2.1      設計構思     
             說明對本系統設計的構思、採用的關鍵技術、主要演算法和關鍵資料結構。   
   2.2.2      系統流程   
   a.    用流程圖示出本系統的主要控制流程程和處理流程；   
             b.    用流程圖示出本系統主要的資料通路，並說明處理的主要階段。   
   2.2.3      結構設計   
             a.    系統元素   
             確定本系統的元素及其功能，用一覽表說明本系統的系統元素（各層模組、子程式、公用程式等）的劃分，按層次給出它們的標識符和功能。   
             b.    系統階層   
             用框圖分層次地給出各個系統元素之間的控制和被控制的關係。   
   2.2.4      功能需求與程式的關係   
             用功能需求與程式的矩陣圖表形式    ，示出各項功能的實現與各系統元素之間的分配關係。   
   3      系統資料結構設計   
   3.1      資料結構   
             列出本系統所使用的主要資料結構，包括名稱、標識符及資料項目等。   
   3.2      資料結構與系統元素之間的關係   
                       用資料結構與系統元素之間的矩陣圖表形式，示出各個資料結構與訪問這些資料結構的系統元素之間的關係。   
   4　介面設計   
   4.1      使用者介面   
             說明本系統向使用者提供的命令、文法結構及系統回答資訊等。   
   4.2      外部介面   
   說明本系統的軟體同硬體和支援軟體之間的介面。   
   4.3      內部介面   
             說明本系統內部相關模組之間的介面。   
   5      運行設計   
   5.1      系統初始化   
             說明本系統初始化過程。             
   5.2      運行模組組合   
             說明本系統每項外界運行需經過哪些內部模組的組合和支援軟體。         
   5.3      運行控制   
             說明每項外界啟動並執行控制方式、方法和操作步驟。         
   5.4      已耗用時間   
             說明每項運行模組組合預計佔用各種資源的時間。         
   5.5      運行安全   
             說明系統安全啟動並執行控制。         
   6      資訊結構設計（當有相關需求或軟體規格定義有要求時）   
       按邏輯結構和物理結構給出本軟體有關資訊的設計要點。   
   6.1      邏輯結構設計   
   6.1.1      圖形設計       
   6.1.2      中文（包括單個漢字、短語、片語。）設計   
   6.2      物理結構設計   
   6.2.1      圖形設計   
   6.2.2      中文（包括單個漢字、短語、片語。）設計   
   6.3      資訊結構與程式的關係   
         用資訊結構與系統元素之間的矩陣圖表形式，示出各個資訊結構與訪問這些資訊結構的系統元素之間的關係。         
   7　出錯處理和維護   
   7.1      出錯資訊   
             用一覽表列出本系統各種可能出錯或故障的資訊形式及其含義。   
   7.2      補救措施   
             說明系統故障出現後可能採取的變通措施，包括：   
   a.    後備技術——當系統未經處理資料一旦丟失時，啟用副本的建立和啟動技術；   
         b.    降效技術——使用另一效率稍低的方法以求得所需結果的某些部份，如手工操作和人工記錄資料；   
         c.    恢複及再啟動技術——讓系統從故障點恢複執行或系統從新啟動啟動並執行方法等。       
   7.3      系統維護   
             說明專門安排用於系統檢測與維護的檢測點和系統檢測維護的專用模組等。     
   8      尚待解決的問題   
       說明本設計中尚未解決而系統完成之前應該解決的問題。       
    
   附加說明：   
   *    本規範根據國家標準GB/T    8566—1995的規定，參照國家標準GB    8567—88    而制定；   
   *    編寫本文檔時，要求具有本規範規定的所有條目。如果某條目內容在其他地方已說明或無內容可填寫，應聲明或填寫“無內容可填寫”    ，並在可能的情況下說明理由。   
   *    編製文檔時，文檔排印格式按“文檔排版印刷格式約定”編製。