軟件概要設計說明書—模板
1 引言
1.1 目的介紹編寫本文檔的目的,主要內容及讀者。
1.2 需求概述
描寫敘述所要實現的功能和性能等。
1.3 名詞及縮略語
列出文檔中所用到的專門術語的定義和縮寫詞的原文。
1.4 參考資料
可包含:
a. 項目經核準的計劃任務書、合同或上級機關的批文。
b. 項目開發計劃。
c. 需求規格說明書;
d. 文檔所引用的資料、標準和規範。列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源。
參考資料清單
序號 名稱 作者
編號 公布日期
查閱地點或渠道
1.
2.
3.
4.
2 軟件概述
介紹軟件的應用場合,開發和執行的背景、設計約束等等。
2.1 系統概況
描寫敘述軟件的主要功能,以及本模塊和子系統在系統中所處的位置和作用。
2.2 執行環境
描寫敘述軟件執行的軟硬件環境。
2.3 設計約束
列出進行本軟件開發工作的假定和約束。如所採用的語言、開發工具、開發平臺、中間件、數據庫、外部接口。以及遵循的編碼和測試規範等。
3 整體結構設計
3.1 軟件結構
用框圖的形式說明本系統的系統元素(各層模塊、子程序、公用程序等)的劃分。扼要說明每一個系統元素的標識符和功能,分層次地給出各元素之間的控制與被控制關系。
3.2 設計思想
結合上圖闡述本系統的基本設計思想和理念。
3.3 尚未解決的問題
說明在概要設計過程中尚未解決而設計者覺得在系統完畢之前必須解決的各個問題。
4 模塊設計
在此以列表形式說明各模塊的名稱、功能、接口、公布形式等信息。
4.1 模塊1
具體描寫敘述各功能模塊的功能、接口及內部實現。
4.1.1 功能描寫敘述
能夠以圖表方式說明本功能區域的內部結構,與其它功能模塊的具體數據接口流。
4.1.2 接口描寫敘述
消息、函數等
4.1.3 數據結構描寫敘述
本功能區域使用的數據結構。
4.1.4 類和對象描寫敘述
採用類圖和對象圖描寫敘述。
4.1.5
畫出模塊各項功能的實現流程。
4.1.6 編譯和鏈接說明
對模塊的編譯和鏈接提出要求,如靜態鏈接、動態鏈接,生成obj、lib、DLL、bin、hex等。
4.2 模塊2
……
5 執行設計
以列表方式描寫敘述系統的任務、線程、進程的設置,包含類型、功能、優先級、管理方法等。
6 功能實現流程
以用例圖、順序圖、SDL圖等方式,具體描寫敘述各項功能的實現流程。
7 系統性能分析
列出系統關鍵性能指標。而且對影響系統性能的功能點進行分析。
8 數據庫及數據結構設計
8.1 數據庫及數據表
描寫敘述所使用的數據庫系統,及數據庫和數據表設計。
8.2 數據結構設計
給出本系統內所使用的每一個數據結構的名稱、標識符以及它們之中每一個數據項、記錄、文卷和系的標識、定義、長度及它們之間的層次的或表格的相互關系。
8.3 數據存儲設計
給出本系統內所使用的每一個數據結構中的每一個數據項的存儲要求,訪問方法、存取單位、存取的物理關系(索引、設備、存儲區域)、設計考慮和保密條件。
9 定時器設計
列表描寫敘述全部定時器的類型、用途、範圍、默認值、啟動、停止、掃描、超時處理等。
10 外部接口設計
說明本系統同外界的全部接口的安排包含軟件與硬件之間的接口、與各支持軟件之間的接口、與網管之間的接口等。
10.1 用戶界面設計
參見《UI設計說明書》。
10.2 硬件接口
描寫敘述須要訪問的硬件接口的類型、控制方式,:如中斷、寄存器等。
10.3 軟件接口
描寫敘述與其它模塊及子系統的接口。
11 兼容性設計
列出與前後版本號,以及其它模塊、系統、子系統間可能存在的兼容性問題,以及對策。
12 系統維護設計
12.1 安裝和升級
描寫敘述軟件安裝和使用方面的考慮。
描寫敘述軟件升級的方式。以及升級時的兼容性和數據遷移方面的考慮。
12.2 系統配置
列出系統各種配置項的內容。
12.3 日常維護
假設有日常維護的須要,給出詳細的實現方法。
13 系統測試設計
從代碼的靜態測試,到執行時的動態測試等方面具體描寫敘述實現方法。
14 安全和可靠設計
14.1 系統安全
1. 系統安全控制和物理保護措施
2. 用戶身份鑒別機制
3. 用戶對系統的訪問權限和範圍
14.2 數據安全
說明在數據庫的設計中,將怎樣通過區分不同的訪問者、不同的訪問類型和不同的數據對象,進行分別對待而獲得的數據庫安全保密的設計考慮,如:
1. 數據用戶身份鑒別
2. 訪問時的控制策略和實現方法
3. 數據加密方法
14.3 可靠性設計
14.3.1 故障模式及影響分析(FMEA)
列表分析各種可能的故障模式,以及對應的對策。
14.3.2 避錯和容錯設計
列舉所採取的避錯和容錯設計措施,減少系統故障概率。
14.3.3 冗余設計
如採取系統冗余、 數據冗余等措施。
14.3.4 故障檢測和恢復機制
能夠採用watchdog、守護進程、異常處理等機制檢測系統故障。而且進行局部或全局重新啟動動機制,恢復系統執行。
對於數據的恢復。能夠從冗余或備份數據中恢復。
15 日誌和錯誤處理
15.1 日誌記錄機制
用一覽表的方式說明每種可能的日誌(如執行日誌、操作日誌、故障日誌)怎樣進行記錄。記錄那些內容。
15.2 錯誤信息及輸出機制
用一覽表的方式說明每種可能的出錯或故障情況出現時,系統輸出信息的形式、含義及處理方法。
來源:http://blog.csdn.net/lezhiyong
軟件概要設計說明書—模板