碧瑤答疑網-軟件需求規格說明書
GitHub鏈接:https://github.com/sjzsjzsjz/analyse
1. 引言
1.1 目的
本文檔首先給出項目的整體結構和功能結構概貌,試圖從總體架構上給出整個系統的輪廓。同時對功能需求、性能需求進行了詳細的描述。便於用戶、開發人員進行理解和交流,反映出用戶問題的結構,可以作為軟件開發工作的基礎和依據以及確認測試和驗收的依據。
本文檔面向多種讀者對象:
(1)項目經理:項目經理可以根據該文檔了解預期產品的功能,並據此進行系統設計、項目管理。
(2)設計員:對需求進行分析,並設計出系統,包括數據庫的設計。
(3)程序員:了解系統功能,編寫《用戶手冊》。
(4)測試員:根據本文檔編寫測試用例,並對軟件產品進行功能性測試和非功能性測試。
(5)用戶:了解預期產品的功能和性能,並與分析人員一起對整個需求進行討論和協商。
在閱讀本文檔時,首先要了解產品的功能概貌,然後可以根據自身的需要對每一功能進行適當的了解。
1.2 背景
本次待開發的網站為碧瑤答疑網。用戶通過使用該網站在移動終端完成資訊瀏覽、交流、發帖及回帖等操作,以實現答疑解惑的目的。
1.3 定義
序號 |
縮寫 |
定義 |
1. |
Web |
網站,Website的縮寫,一般指用於展示特定內容的相關網頁的合集。 |
2. |
Windows |
Microsoft Windows,是一種基於圖形化模式GUI,主要使用於電腦的操作系統,由美國微軟公司研發。 |
1.4參考文獻
[1] GB-T8567-2006,《計算機軟件文檔編制規範》[S].
[2] 鄒欣著.構建之法 現代軟件工程.第三版.人民郵電出版社,2015
2. 項目概述
2.1 產品描述
通過開發基於Windows平臺的網站完成資源整合及用戶交流等操作,以實現為用戶答疑解惑的目的。
2.2 產品功能
人們在學習和工作上經常會遇到各種各樣的問題,希望與業內人士進行交流,互相取經,但很難找到一個合適的平臺,或者需要查找一些相關資料,但卻因為網上林林總總的資源而感到頭暈目眩。因此我們通過此次碧瑤答疑網的開發,解決用戶的上述困擾。
用戶場景如下:
用戶A在課後學習過程中遇到了難題,身邊的同學也不懂。於是他上網百度,可是搜索出來的結果要麽就不是自己想要的回答,要麽就是看不懂答案沒有解析。
碧瑤答疑網的幫助方式:
網站共有四個模塊,包括問題列表、問題發表、討論區、個人中心。用戶A(提問者)在碧瑤答疑網上發帖提問,用戶B(答疑者)在瀏覽問題列表時看到了這條問題貼跟自己的專業有關,於是發起回帖,幫助用戶A解決了問題。兩人因誌同道合便互加好友,進一步展開交流。
2.3 用戶特點
本網站的用戶為有信息咨詢需要的人,所有人都可能是碧瑤答疑網的用戶。
2.4 一般約束
進行本軟件開發工作的約束條件如下:
(1)開發周期短:兩個月的開發時間需要開發者合理規劃時間,做到多項任務並發。
(2)所采用的方法與技術有限:項目團隊成員的技術水平不夠成熟,需要在開發中並發學習多種技術和能力。
2.5 假設與依據
本項目是否能夠成功實施,主要取決於以下的條件:
(1)團隊成員的積極合作配合,為了項目的開發和實施,對個人時間進行合理規劃,同時為團隊做出合理犧牲,配合隊友完成任務。
(2)課程教師提供完整詳細的功能和性能需求資料,以便於團隊對其進行分析,從而形成完善的軟件需求。
(3)團隊掌握先進的能夠適用於該項目的技術,這是系統的性能是否優化和項目能否成功的保證。
3. 具體需求
首先引入類圖明確該項目中的角色分類及其角色間的相互聯系。
3.1 功能需求
1. 註冊界面
新用戶通過用戶名輸入,密碼輸入,再次確認密碼,實現賬戶註冊。
2. 登錄界面
用戶通過輸入用戶名和密碼,點擊登錄,登錄之後進入碧瑤答疑網的主界面。
3. 問題列表界面
用戶通過點擊導航條上面的“問題列表”,就會按時間順序顯示出其他用戶發表的問題貼及回帖,問題和答案會以不同的顏色顯示。
4. 發表問題界面
用戶通過點擊導航條上面的“發表問題”,就會進入發表問題的界面,該界面可以發表自己的問題貼,其中包括圖片及視頻插入功能,點擊發表按鈕,消息就會出現在最新的問題列表當中。
5. 討論區界面
用戶通過點擊導航條上面的“討論區”就會進入到學習交流區域,可以和不同的用戶互相討論與交流。
6. 個人聊天界面
用戶點擊“個人聊天界面”就進入到了一個簡潔的聊天頁面,在這裏,你可以跟你的好友私聊,別人無法看到,也能在這裏實現添加好友、刪除好友的功能,然後還有一個註銷登陸的功能,註銷登陸後就返回到一開始的登錄界面。
3.2 外部接口需求
3.2.1 用戶接口
本系統采用C/S架構,即客戶/服務器模式,所有界面使用Web風格,用戶界面的具體細節在功能需求文檔中描述。
3.2.2 硬件接口
無特殊需求。
3.2.3 軟件接口
無特殊需求。
3.2.4 通信接口
無特殊需求。
3.3 性能需求
類別 |
字段 |
精度 |
|
用戶類 |
用戶名 |
UserName |
6-18個字符 |
密碼 |
Password |
6-18個字符 |
|
性別 |
Name |
只有“男”、“女” |
|
手機號 |
PhoneNumber |
11位數字 |
|
生日 |
Birthday |
不超過32個字符 |
|
所在學校 |
School |
不超過32個字符 |
|
個人說明 |
Describe |
不超過500個字符 |
|
頭像 |
Photo |
大小不超過500k |
|
帖子 |
標題 |
Title |
不超過50個字符 |
發布者 |
Question |
不超過20個字符 |
|
回答者 |
Answer |
不超過20個字符 |
|
圖片 |
Photo |
大小不超過900k |
|
時間 |
Time |
不超過500個字符 |
|
管理員 |
管理員名 |
Admin |
6-18個字符 |
密碼 |
Password |
6-18個字符 |
|
系統類 |
用戶表單 |
Table |
|
帖子列表 |
List |
|
1. 按照規定的數據格式輸入,否則系統提示錯誤並要求重新輸入。
2. 搜索的時候所有包含關鍵字的記錄保證全部搜索到。
3. 程序響應時間在人的感覺和視覺範圍內,長時間無響應應提示用戶刷新。
4. 要求數據庫有很好的更新能力。
5. 能夠適應叠代開發。
3.4 屬性
3.4.1 可用性
(1)方便操作,容易理解。盡量從用戶角度出發,設計簡潔易用的界面。
(2)具有穩定性。系統會更新增加功能,不斷修復 bug,使系統更加穩定。
(3)容錯能力。系統具有一定的容錯和抗幹擾能力,在非硬件故障或非通訊故障時,系統能夠保證正常運行,並有足夠的提示信息幫助用戶有效正確地完成任務。
(4)操作完成時有統一規範的提示信息。例如刪除操作時,系統可提示警示框“您確認刪除記錄嗎?操作不可恢復!”,用戶點擊確認後,系統才執行刪除操作,刪除後可直接返回相關頁面。
3.4.2 安全性
(1)故障處理
正常使用時不應出錯,若運行時出現不可恢復的系統錯誤,也必須保證數據庫完好。
(2)重要數據加密
對一些重要的數據按一定的算法進行加密,如用戶口令、重要參數等。
(3)數據備份
允許用戶進行數據的備份和恢復,以彌補數據的破壞和丟失。
(4)記錄日誌
本系統應該能夠記錄系統運行時所發生的所有錯誤,包括本機錯誤和網絡錯誤。這些錯誤記錄便於查找錯誤的原因。日誌同時記錄用戶的關鍵性操作信息。
3.4.3 可維護性
(1)保留系統對應的版本的源代碼。
(2)代碼一定要有註釋,特別是關於 if else,每個條件到底意味這什麽,一定要有清晰的描述。
(3)清晰的系統結構和命名規範,界面規範,提示和幫助信息規範,友好的錯誤提示信息,可以幫助用戶自己找原因,自己維護系統。
(4)完善的系統配置管理,在項目開始之後,就需要進行,直到項目結束之後,維護工作
中,仍然需要不斷更新系統配置信息。按模塊對系統進行配置項的劃分,對系統每次維護工
作,都進行記錄,留待將來檢查。
4. 驗收驗證標準
4.1 文檔驗收標準
1. 開題報告
2. 軟件需求規格說明書
3. 項目總結報告
4.2 軟件驗收標準
1. 網站網址
2. 後臺管理程序(PC端)
4.3 界面驗收標準
測試功能 |
測試項 |
輸入/操作 |
檢驗點 |
預期結果 |
驗收情況 |
登錄功能 |
初始界面 |
用戶名、密碼為空 |
登錄按鍵完整 |
||
用戶名可以為中文或者英文 |
用戶名的輸入框完整 |
||||
密碼長度最多18位 |
密碼框完整 |
||||
登錄動作 |
無信息輸入,點擊登錄 |
確認功能、結果顯示 |
登錄失敗 |
||
警告提示:“請輸入用戶名和密碼” |
|||||
僅輸入用戶名或密碼(輸入類型正確;無論存在與否)其一,點擊登錄 |
確認功能、結果顯示 |
登錄失敗 |
|||
警告提示:“請輸入完整登陸信息” |
|||||
輸入用戶名及密碼,兩者其一錯誤或都錯誤(輸入類型正確),點擊登錄 |
確認功能、結果顯示 |
登錄失敗 |
|||
警告提示:“請輸入正確的登陸信息” |
|||||
選擇功能 |
主界面 |
|
主導航為發表問題、問題列表、討論區、個人聊天 |
主導航四個功能的按鍵 |
|
選擇動作 |
點擊問題列表 |
跳轉功能 |
跳轉至問題列表界面 |
|
|
點擊發表問題 |
跳轉功能 |
跳轉至發表問題界面 |
|
||
點擊討論區 |
跳轉功能 |
跳轉至討論區界面 |
|
||
點擊個人聊天 |
跳轉功能 |
跳轉至個人聊天界面 |
|
||
問題列表模塊 |
初始界面 |
點擊相應問題 |
跳轉功能 |
跳轉到問題詳細描述界面 |
|
發表問題模塊 |
發表問題界面 |
|
跳轉功能 |
發表完問題跳回到主界面 |
|
討論區模塊 |
討論區界面 |
|
|
發表個人想法在當前頁面顯示 |
|
個人聊天模塊 |
選擇動作 |
點擊其中一個好友 |
|
顯示相應的對話框 |
|
點擊註銷賬號 |
跳轉功能 |
跳轉到登錄界面 |
|
||
點擊添加好友 |
跳轉功能 |
跳轉到好友添加界面 |
|
||
點擊刪除好友 |
確認功能、結果顯示 |
刪除好友成功 |
|
||
修改個人資料 |
跳轉功能 |
跳轉到修改界面,編輯個人資料並保存 |
|
碧瑤答疑網-軟件需求規格說明書