服務近2000家企業,依托一系列實踐中打磨過的技術和產品,根據企業的具體業務問題和需求,針對性的提供各行業大數據解決方案。
軟件系統詳細設計說明書模板和范例
來源:未知 時間:2021-25-14 瀏覽次數:1,649次
1. 引言
1.1 編寫目的和范圍
說明寫這份詳細設計說明書的目的。本詳細設計說明書編寫的目的是說明程序模塊的設計考慮,包括程序描述、輸入/輸出、算法和流程邏輯等,為軟件編程和系統維護提供基礎。本說明書的預期讀者為系統設計人員、軟件開發人員、軟件測試人員和項目評審人員。
1.2 術語表
定義系統或產品中涉及的重要術語,為讀者在閱讀文檔時提供必要的參考信息。| 序號 | 術語或縮略語 | 說明性定義 |
| 1 | PM | Project Manager,項目經理 |
| 2 | ||
1.3 參考資料
列出有關資料的名稱、作者、文件編號或版本等。參考資料包括:a.需求說明書、架構設計說明書等;
b.本項目的其他已發表的文件;
c.引用文件、資料、軟件開發標準等。
| 資料名稱 | 作者 | 文件編號、版本 | 資料存放地點 |
1.4 使用的文字處理和繪圖工具
文字處理軟件:[編寫設計文檔使用的文字處理軟件,如RedOffice ]繪圖工具:[使用的UML工具,如Rose、Jude、Visio]
2. 全局數據結構說明
本章說明本程序系統中使用的全局數據常量、變量和數據結構。2.1 常量
包括數據文件名稱及其所在目錄,功能說明,具體常量說明等。2.2 變量
本章說明本程序系統中使用的全局數據常量、變量和數據結構。2.3 數據結構
包括數據結構名稱,功能說明,具體數據結構說明(定義、注釋、取值)等。3. 模塊設計
3.1 用例圖
3.2 功能設計說明
3.2.1 XXX
描述3.2.1.1 a
3.2.1.2 b
3.2.1.3 c
3.2.1.3.1 設計圖
3.2.1.3.2 功能描述
簡要描述子模塊1的業務功能。3.2.1.3.3 輸入數據
詳細描述用戶輸入的數據(包括任何輸入設備)以及這些數據的有效性檢驗規則。詳細描述從物理模型中的哪些表獲取數據以及獲取這些數據的條件。
3.2.1.3.4 輸出數據
詳細描述子功能1所產生的數據以及這些數據的表現形式。3.2.1.3.5 業務算法和流程
從業務角度詳細描述根據輸入數據產生輸出數據的業務算法和流程。3.2.1.3.6 數據設計
給出本程序中的局部數據結構說明,包括數據結構名稱,功能說明,具體數據結構說明(定義、注釋設計、取值)等。相關數據庫表,數據存儲設計(具體說明需要以文件方式保存的數據文件名、數據存儲格式、數據項及屬性等。)3.2.1.3.7 源程序文件說明
給出本程序的各源程序文件的說明,包括源程序文件名稱及其所在目錄,功能說明,包含的前導文件及函數名稱等。3.2.1.3.8 函數說明
具體說明本程序中的各個函數,包括函數名稱及其所在文件,功能,格式,參數,全局變量,局部變量,返回值,算法說明,使用約束等。3.2.1.3.9 限制條件
3.2.1.3.10 其他說明
4. 接口設計
4.1 內部接口
4.2 外部接口
4.2.1 接口說明
例如:xx子系統通過xx從xx子系統取得xx等,相關標準,調用示例,可根據需要增加章節描述接口。4.2.2 調用方式
例如:內部接口調用:例:
/**
*通過用戶服務號碼取得該客戶認證密碼等信息,如果該客戶存在返回為0,其他情況參考錯誤編碼
*/
public RUserInfo getUserInfo (String userNo);
5. 數據庫設計
詳見[xxx數據庫設計說明書]如果數據庫設計內容比較少,則直接在此處描述。
用戶表
| 字段名 | |
| 用戶名 | |
| 密碼 | |
| 來源 | |
| 原始ID | |
| 創建日期 |
6. 系統安全保密設計
6.1 說明
例如:由于存在與外部系統的接口,所以需要考慮訪問安全的問題.6.2 設計
例如:分為數據傳輸部分,IP過濾部分,身份驗證部分.[章節可補充]6.2.1 數據傳輸部分
例如:在部分數據傳遞的時候,考慮以https協議,需要在部署的時候作相關處理.6.2.2 IP過濾分部
例如:可在系統前端通過Filter實現,該Filter實現對該地址訪問的IP過濾作用.可信任IP地址通過xml文件進行配置.6.2.3 身份驗證部分
例如:對信任的用戶,頒發身份驗證碼,通過該標識進行身份識別.7. 系統性能設計
8. 系統出錯處理
例如:為了在系統出現異常情況下給用戶以明確的提示,可采用兩種方式予以提示:1.使用Javascript的alert()函數直接提示,這主要在輸入或修改的情況下使用;
2.使用統一的錯誤界面提示,該界面對應于errorpage.jsp頁面。錯誤界面樣式如下圖所示:
![]() |
軟件系統詳細設計說明書模板1 |
![]() |
軟件系統詳細設計說明書模板2 |
![]() |
用戶管理系統范例 |
- 上一篇: 自然資源信息軟件系統解決方案
- 下一篇: 智慧交通大數據平臺設計方案

掃一掃