概要設(shè)計說明書(文檔格式)

引言編寫目的闡明編寫本概要設(shè)計說明書的目的，指出讀者對象。項目背景列出本項目的委托單位、開發(fā)單位和主管部門，說明該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。定義列出本文檔中所用到的專門術(shù)語的定義和縮寫詞的原意。參考資料列出有關(guān)資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源。包括本項目經(jīng)核準的計劃任務(wù)書、合同或上級機關(guān)的批文，項目開發(fā)計劃，需求規(guī)格說明書，本文檔需要引用的論文、著作，需要采用的標準、規(guī)范。需求概述功能要求列出必須實現(xiàn)的功能，可以擴充的功能?？墒褂孟到y(tǒng)層次圖說明系統(tǒng)功能組織結(jié)構(gòu)。性能要求說明系統(tǒng)需要具備數(shù)據(jù)精度、時間特性、適應(yīng)性等。運行環(huán)境說明系統(tǒng)運行時需要具備的硬件環(huán)境、操作系統(tǒng)、支撐軟件環(huán)境、數(shù)據(jù)環(huán)境、網(wǎng)絡(luò)環(huán)境以及需要一起協(xié)同工作的其他軟件和設(shè)備環(huán)境等。條件與限制說明軟件系統(tǒng)在功能和性能方面的特殊要求。系統(tǒng)設(shè)計目標說明概要設(shè)計將要采用的設(shè)計思路和需要達到的設(shè)計目標。系統(tǒng)設(shè)計原則說明概要設(shè)計需要遵循的設(shè)計原則。系統(tǒng)總體設(shè)計處理流程使用系統(tǒng)流程圖說明軟件系統(tǒng)的處理流程?？傮w結(jié)構(gòu)設(shè)計描述軟件系統(tǒng)中模塊的組成關(guān)系?？墒褂密浖Y(jié)構(gòu)圖或類圖進行描述。功能分配說明各項功能與軟件結(jié)構(gòu)的關(guān)系。模塊接口設(shè)計外部接口說明系統(tǒng)與其他外部組件之間的接口關(guān)系，包括界面接口、軟件接口與硬件接口。內(nèi)部接口說明系統(tǒng)內(nèi)部各個模塊之間的接口、調(diào)用關(guān)系以及模塊之間的數(shù)據(jù)傳遞關(guān)系等。數(shù)據(jù)結(jié)構(gòu)設(shè)計邏輯結(jié)構(gòu)設(shè)計描述系統(tǒng)需要使用的數(shù)據(jù)（如數(shù)據(jù)表、數(shù)據(jù)項、記錄、文件）的標識、定義、長度等邏輯特征以及它們之間的邏輯關(guān)系。物理結(jié)構(gòu)設(shè)計描述系統(tǒng)需要使用的數(shù)據(jù)（如數(shù)據(jù)表、數(shù)據(jù)項、記錄、文件）的存儲要求、訪問方式、存取單位等物理特征以及它們之間的物理關(guān)系。數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系描述系統(tǒng)需要使用的數(shù)據(jù)與程序模塊之間的關(guān)聯(lián)，說明哪些數(shù)據(jù)將被哪些模塊所用。運行控制設(shè)計運行模塊的組合描述系統(tǒng)運行時，模塊之間的通信與組合關(guān)系?？墒褂媚K結(jié)構(gòu)圖、對象協(xié)作圖等進行描述。運行控制描述系統(tǒng)運行時，模塊之間的調(diào)用控制關(guān)系，涉及控制范圍、作用范圍等。運行時間說明系統(tǒng)運行時，系統(tǒng)中的運行模塊對時間的要求。出錯處理設(shè)計出錯輸出信息用圖表方式列出當每種可能的出錯或故障情況出現(xiàn)時，系統(tǒng)出錯信息的輸出形式、含義及處理方法。出錯處理對策如設(shè)置后備服務(wù)、性能降級、恢復(fù)及再啟動等。系統(tǒng)安全性保密性設(shè)計說明對人員登錄、操作歷史、數(shù)據(jù)編輯等方面的保密和控制措施。系統(tǒng)操作權(quán)限分級管理將系統(tǒng)操作權(quán)限分為系統(tǒng)管理員級、部門級、崗位級和個人級，采用口令方式登錄，口令可由使用者自行設(shè)置。特定功能的操作校驗為保證數(shù)據(jù)讀寫、更改、刪除無誤，可以采用警告信息提請注意，經(jīng)確認后再提交上述編輯操作。文件與數(shù)據(jù)加密可利用數(shù)據(jù)庫管理系統(tǒng)或前臺開發(fā)工具所具有的安全保密功能，對文件和數(shù)據(jù)進行加密處理。非法使用數(shù)據(jù)的記錄和檢查可建立操作日志，對每一個操作點的操作內(nèi)容進行全程自動記錄。系統(tǒng)內(nèi)保存至少半個月的操作日志記錄以備查，采用光盤或磁帶備份一年內(nèi)的操作日志