各位同學:
課程作業:軟件設計說明書模板鏈接:
鏈接:http://pan.baidu.com/s/1cJmTFS 密碼:joqv
主要內容如下,請各位同行批評指正。
四川師范大學 |
軟件設計說明書 |
XXXX系統軟件設計說明書 |
團隊名稱 [日期]
|
目錄
文檔變更記錄... 0
引言... 0
1.1 項目介紹... 0
1.2 開發團隊... 0
1.3 使用的文字處理和繪圖工具... 0
靜態體系設計... 0
2.1 全局數據結構... 0
2.2 模塊設計... 1
2.2.1 模塊划分... 1
2.2.2 系統類圖及說明... 1
2.3 界面設計... 1
2.4 數據庫設計... 1
動態結構... 1
3.1 用例順序圖... 1
3.2 需說明的對象狀態圖... 1
3.3 內外部接口... 1
其他設計... 1
4.1 安全性設計... 1
4.1.1 說明... 1
4.1.2 數據傳輸設計... 2
4.1.3 身份驗證設計... 2
4.2 系統錯誤處理... 2
4.3 系統性能設計... 2
附錄... 2
5.1 詞匯表... 2
5.2 參考文獻... 3
文檔變更記錄
序號 |
變更(+/-)說明 |
作者 |
版本號 |
日期 |
批准 |
1 |
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
引言
1.1 項目介紹
//這部分寫項目的簡介和意義。
1.2 開發團隊
//這部分寫軟件項目開發團隊
老板:李巍
項目經理:xxxx
系統架構師:xxxx
軟件工程師:xxxx
測試工程師:xxxx
需求分析師:xxxx
......
1.3 使用的文字處理和繪圖工具
文字處理軟件:[編寫設計文檔使用的文字處理軟件,如RedOffice ]
繪圖工具:[使用的UML工具,如Rose、Jude、Visio]
靜態體系設計
2.1 全局數據結構
程序使用的全局性常量、變量、數據結構。
2.2 模塊設計
2.2.1 模塊划分
軟件系統分為哪些模塊
2.2.2 系統類圖及說明
系統類圖(此部分為重點,要能夠展示系統的靜態結構)。
2.3 界面設計
界面的設計風格、界面設計圖、界面元素說明。
2.4 數據庫設計
數據庫表單設計(如不使用數據庫則不用寫)。
動態結構
3.1 用例順序圖
用例順序圖
3.2 需說明的對象狀態圖
對象狀態圖
3.3 內外部接口
例如:xx子系統通過xx從xx子系統取得xx等,相關標准,調用示例,可根據需要增加章節描述接口。
其他設計
4.1 安全性設計
4.1.1 說明
對系統安全性需求的說明。
4.1.2 數據傳輸設計
例如:在部分數據傳遞的時候,考慮以https協議,需要在部署的時候作相關處理.
例如:可在系統前端通過Filter實現,該Filter實現對該地址訪問的IP過濾作用.可信任IP地址通過xml文件進行配置.
4.1.3 身份驗證設計
例如:對信任的用戶,頒發身份驗證碼,通過該標識進行身份識別.
4.2 系統錯誤處理
例如:為了在系統出現異常情況下給用戶以明確的提示,可采用兩種方式予以提示:
1.使用Javascript的alert()函數直接提示,這主要在輸入或修改的情況下使用;
2.使用統一的錯誤界面提示,該界面對應於errorpage.jsp頁面。錯誤界面樣式如下圖所示:
錯誤提示界面
4.3 系統性能設計
例如,從接收到用戶輸入到路徑規划完成,總用時不得超過3秒鍾。
附錄
5.1 詞匯表
定義系統或產品中涉及的重要術語,為讀者在閱讀文檔時提供必要的參考信息。
序號 |
術語或縮略語 |
說明性定義 |
1 |
PM |
Project Manager,項目經理 |
2 |
|
|
|
|
|
5.2 參考文獻
團隊名稱:
團隊成員:
123456701(學號) 蔡何(姓名)
團隊貢獻分:
123456701(學號) 蔡何 6分;
......
得分:教師填寫
評語:教師填寫