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