Github項目地址:https://github.com/pirigg/shishengwendapingtaigit
<師生問答平臺網站>程序員
需求規格說明書github
做者: 騎着烏鴉打飛機小組web
完成日期: 2019.5.8數據庫
修訂歷史記錄api
日期瀏覽器 |
版本安全 |
說明服務器 |
做者網絡 |
2019.5.8 |
V1.0 |
第一個版本,根據項目主體架構造成 |
|
|
|
|
|
|
|
|
|
|
|
|
|
目錄
1. 引言 4
1.1 目的 4
1.2 背景 4
1.3 定義 4
1.4 參考文獻 4
2. 項目概述 5
2.1 產品描述 5
2.2 產品功能 5
2.3 用戶特色 7
2.4 通常約束 7
2.5 假設與依據 7
3. 具體需求 8
3.1 功能需求 9
3.1.1登錄界面 9
3.1.2管理員類 14
3.2 外部接口需求 14
3.2.1 用戶接口 14
3.2.2 硬件接口 15
3.2.3 軟件接口 15
3.2.4 通訊接口 15
3.3 性能需求 15
3.4 屬性 16
3.4.1 可用性 16
3.4.2 安全性 16
3.4.3 可維護性 16
4. 驗證驗收標準 18
4.1 文檔驗收標準 18
4.2 軟件驗收標準 18
4.3 界面驗收標準 18
4.3.1 用戶界面 18
4.3.2 管理員界面 19
4.4 功能驗收標準 20
4.4.1 用戶類 20
4.4.2 管理員類 22
4.5 其餘驗收標準 23
1.1 目的
該文檔首先給出項目的總體結構和功能結構概貌,試圖從整體架構上給出整個系統的輪 廓。同時對功能需求、性能需求進行了詳細的描述。便於用戶、開發人員進行理解和交流, 反映出用戶問題的結構,能夠做爲軟件開發工做的基礎和依據以及確認測試和驗收的依據。
本文檔面向多種讀者對象:
(1) 項目經理:項目經理能夠根據該文檔瞭解預期產品的功能,並據此進行系統設計、項 目管理。
(2) 設計員:對需求進行分析,並設計出系統,包括數據庫的設計。
(3) 程序員:瞭解系統功能,編寫《用戶手冊》。
(4) 測試員:根據本文檔編寫測試用例,並對軟件產品進行功能性測試和非功能性測試。
(5) 用戶:瞭解預期產品的功能和性能,並與分析人員一塊兒對整個需求進行討論和協商。 在閱讀本文檔時,首先要了解產品的功能概貌,而後能夠根據自身的須要對每一功能進
行適當的瞭解。
1.2 背景
網上論壇是一種供人們進行交流的網絡空間。它不受時間和空間的約束,論壇用戶能夠發表本身的觀點,你們一塊兒探討某個問題。實現用戶與用戶間的交流,利用網絡經濟而又快捷地與外界進行各類信息溝通,取得更有用的信息資源。目前,網上論壇已不是新事物,許許多多的別具特點的論壇在網絡上隨處可見。
對當代大學生而言,刷論壇更是屢見不鮮。虎撲,知乎,小紅書等論壇均可見他們的身影。男生熱衷於籃球、球鞋等論壇。女生沉迷於美妝美食服飾等論壇。對於他們而言,在論壇上交流比面對面的交流顯得更自在。這是當代大學生的現狀。
1.3 參考文獻
[1] GB-T8567-2006,《計算機軟件文檔編制規範》[S]
[2](. 美)Roger S.Pressman 著,鄭人傑等譯.軟件工程[M].第七版.北京:機械工業出版社,2011.
使用web框架搭建一個師生在線問答網站。
2.2 產品功能
爲了知足師生平常問答的須要,本項目計劃階段完成以下四個核心功能:
1.用戶的提問、發帖、回答功能
2.點贊功能,可讓優質的答案推薦到最上面,
3.舉報功能,若是提問的話題敏感、不合理,用戶能夠舉報,管理員收到舉報信息後對內容進行審覈。
4.智能推薦問題功能,在點開網頁,有推薦欄目,裏面是每一個用戶特有的推薦帖子。
首先經過用例圖瞭解角色分工以下:
2.3 用戶特色
本軟件的用戶爲有問答須要的人,全部的人都有多是該網站的用戶。
2.4 通常約束
進行本軟件開發工做的約束條件以下:
2.5 假設與依據
本項目是否可以成功實施,主要取決於如下的條件:
(1) 團隊成員的積極合做配合,爲了項目的開發和實施,對我的時間進行合理規劃同時爲 團隊作出合理犧牲,配合隊友完成任務。
(2) 團隊掌握先進的可以適用於該項目的技術,這是系統的性能是否優化和項目可否成功 的保證。
咱們引入下面的類圖明確該項目中的角色分類及其角色間的相互聯繫
3.1 功能需求
3.1.1登錄界面
用戶輸入用戶名和密碼登錄網站,底部有忘記密碼和註冊選項。
忘記密碼
忘記密碼的用戶經過輸入手機號、新密碼和驗證碼修改密碼
註冊帳號
新用戶輸入用戶名、手機號、密碼和驗證碼註冊新用戶
首頁
左上角點擊返回主頁,跟首頁同樣。點擊話題能夠查詢相應話題的問題,好比生活,學習,娛樂等問題。中間能夠搜索關鍵字查詢問題,也能夠點擊提問按鈕提問問題。右邊三個依次是通知,私信,個人主頁。
點金首頁就是推薦欄目,裏面是每一個用戶特有的推薦帖子。
用戶的功能。
提問功能:點擊提問按鈕,彈出下列提示框,在框內寫下想提出的問題,而後將問題進行分類,而後再點擊發布問題便可將問題發佈在論壇上。
回答功能。
點開問題後進入以下界面
而後點擊寫回答按鈕
寫完回答後就能夠點擊提交回答,將你的回答發佈在問題的下面了。
用戶能夠點擊贊同按鈕進行點贊,可讓優質的回答推薦到問題的下面,讓人容易看到。
發帖功能,點擊別人回答的按鈕就能夠查看其餘人的評論,也能夠本身寫下對這條回答的評論。也能夠在首頁中,點擊寫文章或着寫想法來進行發帖。
舉報功能,若是提問的問題敏感,不合理則會被舉報,經過對問題進行按右鍵會有舉報選項,或者右鍵回答者頭像有舉報選項進行回答舉報。舉報的帖子經管理員審覈進行決定是否刪除。
熱榜欄目,擁有大量回答的問題會上熱榜,可讓用戶知道什麼問題最近被人回答的最多。
查看我的信息
點擊右上角人物圖標,查看我的詳細信息,頭像,暱稱,性別,生日,職業,學校和我的說明。(行業信息改成職業,職業經理改爲學校,由於模板沒有了,只能選兩項湊合如下,深感抱歉。),也能夠進行資料編輯。
點擊返回個人主頁,能夠查看我的主頁,包括我的動態,提問問題,回答,想法等
3.1.2管理員類
登陸界面
管理員輸入管理員帳號密碼登錄
管理進行問題審覈,處理舉報內容等
3.2 外部接口需求
3.2.1 用戶接口
無特殊需求。
3.2.2 硬件接口
無特殊需求。
3.2.3 軟件接口
瀏覽器:市面上大多數瀏覽器
數據庫:MYSQL
開發工具:Atom Hbuilder
3.2.4 通訊接口
3.3 性能需求
類別 |
字段 |
|
精度 |
用戶 |
用戶名 |
userName |
6-18 位數字或者字母 |
手機號 |
phoneNumber |
11 位數字 |
|
密碼 |
password |
6-18 位數字或者字母 |
|
職業 |
occupation |
不超過 32 個字符 |
|
我的描述 |
description |
不超過 512 個字符 |
|
帖子 |
標題 |
title |
不超過 64 個字符 |
提問人 |
location |
不超過 64 個字符 |
|
所屬板塊 |
Belongto |
對應板塊數字 |
|
描述 |
descrption |
不超過 512 個字符 |
處理 |
舉報違規 |
Report |
是/否 |
頂/埋帖 |
Up/dowm |
頂/埋 |
3.4 屬性
3.4.1 可用性
(1) 易操做,易理解。界面設計簡潔易用。
(2) 穩定性:系統會更新增長功能,不斷修復 bug,使系統更加穩定。
(3) 容錯能力:系統具備必定的容錯和抗干擾能力,在非硬件故障或非通信故障時,系統 可以保證正常運行。
(4) 併發性:可以保證必定量的用戶同時在線使用。
(5) 操做完成時有統一規範的提示信息。例如刪除操做時,系統可提示警示框「您確認刪 除記錄嗎?操做不可恢復!」,用戶點擊確認後,系統才執行刪除操做,刪除後可直接返回 相關頁面。
3.4.2 安全性
(1) 重要數據加密
對一些重要的數據利用可靠的加密技術進行加密。
(2) 記錄日誌
本系統應該可以記錄系統運行時所發生的全部錯誤,包括本機錯誤和網絡錯誤。這些 錯誤記錄便於查找錯誤的緣由。日誌同時記錄用戶的關鍵性操做信息。
(3) 故障處理
正常使用時不該出錯,若運行時出現不可恢復的系統錯誤,也必須保證數據庫無缺。
3.4.3 可維護性
4.1 文檔驗收標準
1.項目開發計劃
2.軟件需求說明書
3.項目總結報告
4.2 軟件驗收標準
(1) 市面上大多數瀏覽器
(2) 手機瀏覽器
4.3 界面驗收標準
4.3.1 用戶界面
序號 |
界面名稱 |
界面描述 |
備註 |
1 |
登陸界面 |
標題欄顯示「登陸」,頁面上半部設置有 logo 圖片,下半部 爲「用戶名」、「密碼」輸入框,「登陸」按鈕。底部左下角爲「忘記密碼」,右下角爲「新用戶」。 |
|
2 |
註冊界面 |
標題欄顯示「註冊」,頁面上半部設置有圖片,下半部爲「用戶名」、「手機號」、「密碼」、「驗證碼」輸入框,「驗證碼」輸入框右邊有「獲取驗證碼」按鈕,再接下來有「確 認」按鈕。 |
|
3 |
忘記密碼界面 |
標題欄顯示「忘記密碼」,頁面依次有「手機號」、「新密碼」、「驗證碼」輸入框,「驗證碼」輸入框右邊有「獲取 驗證碼」按鈕。 |
|
4 |
首頁界面 |
標題欄顯示「首頁」,標題欄左邊是「菜單」按鈕,右邊是「+」(新建帖子)按鈕。標題欄下方,以推薦信息滾屏開始, 並設置了「選擇學校」菜單。滾屏下方是搜索框,搜索框下 面設置了「分類」標籤。再往下是各個帖子。每一個帖子顯示 「用戶名」、「發帖時間」、「帖子描述」、「圖片」。 |
頂部 滾屏信息考慮插入廣告和推薦團 購 |
5 |
菜單界面 |
第一項顯示用戶頭像和用戶名,接下來依次顯示「個人帖子」、 「個人足跡」、「個人收藏」、「設置」。 |
|
6 |
帖子詳情 (他人帖子) |
標題欄顯示「帖子詳情」,標題欄左邊有「<」(返回,下同) 按鈕,右邊有星號(收藏)按鈕。主體是帖子的詳細信息。 |
|
7 |
帖子詳情 (正在進行) |
標題欄顯示「帖子詳情」,標題欄左邊有「<」按鈕,右邊有 「編輯」按鈕,主體是帖子的詳細信息,底部左邊有「刪除」 按鈕,右邊有「完成」按鈕。 |
|
8 |
帖子詳情 (不可編輯) |
標題欄顯示「帖子詳情」,標題欄左邊有「<」按鈕,主體是帖子的詳細信息,底部有刪除按鈕。 |
|
9 |
編輯帖子 |
標題欄顯示「編輯帖子」,標題欄左邊有「<」按鈕,右邊有 發佈按鈕,主體是帖子的信息編輯。 |
|
10 |
我的信息 界面 |
標題欄顯示「我的信息」,標題欄左邊有「<」按鈕,右邊是 「編輯」按鈕,主體顯示包括頭像用戶名等用戶信息。 |
|
11 |
編輯我的 信息界面 |
標題顯示「我的信息」,標題欄左邊有「<」按鈕,右邊是「保 存」按鈕,主體是包括頭像和一些基本信息的修改。 |
|
12 |
正在進行帖子界面 |
標題欄顯示「正在進行」,標題欄左邊有「<」按鈕,主體顯示帖子列表,每一項顯示圖片、描述、剩餘時間,帶有「刪除」、「修改」、「完成」按鈕。底部是導航欄包含「正在 進行」、「過時」、「已完成」。 |
|
13 |
過時帖子界面 |
標題欄顯示「正在進行」,標題欄左邊有「<」按鈕,主體顯示帖子列表,每一項顯示圖片和描述,帶有「刪除」按鈕。 底部是導航欄包含「正在進行」、「過時」、「已完成」。 |
|
14 |
已完成帖子界面 |
標題欄顯示「正在進行」,標題欄左邊有「<」按鈕,主體顯示帖子列表,每一項顯示圖片和描述,帶有「刪除」。底部 是導航欄包含「正在進行」、「過時」、「已完成」。 |
|
15 |
個人足跡 界面 |
標題欄顯示「個人足跡」,標題欄左邊有「<」按鈕,主體顯 示帖子列表,每一項顯示圖片和描述,帶有「刪除」按鈕。 |
|
16 |
個人收藏 界面 |
標題欄顯示「個人收藏」,標題欄左邊有「<」按鈕,主體顯 示帖子列表,每一項顯示圖片和描述,帶有「刪除」按鈕。 |
|
17 |
設置界面 |
標題欄顯示「設置」,主體依次有「版本信息」、「意見反 饋」、「切換帳戶」選項。 |
|
18 |
版本信息 |
標題欄顯示「版本信息」,主體是版本信息。 |
|
19 |
意見反饋 |
標題欄顯示「意見反饋」,主體有反饋內容輸入框和聯繫方 式輸入框,底部有「提交」按鈕。 |
|
4.3.2 管理員界面
序號 |
界面名稱 |
界面描述 |
備註 |
1 |
登陸界面 |
標題欄顯示「登陸」,頁面上半部設置有 logo 圖片,下半部 爲「管理員帳號」、「密碼」輸入框,「登陸」按鈕。 |
|
2 |
忘記密碼 界面 |
標題欄顯示「正在審覈」,右邊有「退出帳號」按鈕,主體 是帖子的列表,下方有「刪除」按鈕刪除帖子。 |
|
3 |
詳細信息 |
標題欄顯示「詳細信息」,標題欄左邊有「<」按鈕返回上一 級,左上角「經過」按鈕,帖子經過審覈。下方顯示帖子詳細信息,底部「刪除按鈕」刪除帖子。 |
|
4.4 功能驗收標準
4.4.1 用戶類
序號 |
功能名 稱 |
操做界 面 |
詳細操做 |
備註 |
1 |
註冊 |
登陸 界面、註冊界面 |
打開網站後,點擊右下角的「新用戶」按鈕,彈出註冊頁面。填入「用戶名」、「手機號」、「密碼」、「驗證碼」,點擊「獲取驗證碼」得到短信驗證碼。點擊「註冊」按鈕提交註冊信息,跳 轉到登陸頁面。 |
|
2 |
登陸 |
登陸 界面 |
打開網站後,在「用戶名」輸入框填入用戶名或者手機號,在「密碼」輸入框輸入密碼,點擊登陸按鈕進行登陸。若是密碼錯誤或者用戶名錯 誤,彈出提示「用戶名不存在或者密碼錯誤!」。 |
|
3 |
忘記密碼 |
開始界面、忘記密碼界 面 |
打開網站 後,點擊左下角的「忘記密碼」按鈕跳轉到忘記密碼頁面。輸入「手機號」和「新密碼」, 點擊「獲取驗證碼」獲取驗證碼,填寫「驗證碼」, 點擊「確認」按鈕提交信息並跳轉到登陸頁面。 |
|
4 |
選擇校區 |
主頁 |
點擊「校區選擇」框,彈出校區列表,滑動瀏覽列表,點擊選擇校區。默認設爲「我的信息」裏 的所在大學。 |
|
5 |
瀏覽帖子 |
主頁、帖子詳情 (他人帖子) |
上下滑動瀏覽帖子,顯示發帖人、發帖時間、標題、圖片。點擊帖子進入「詳細信息」頁面,包括圖片、發帖人、發帖時間、剩餘時間、標題、商品單價、商品地點、預期團購人數、聯繫電話、 描述等。點擊左上角「<」按鈕返回主頁。 |
|
6 |
收藏帖子 |
帖子詳情(他人 帖子) |
點擊右上角星形圖標能夠收藏該帖子並點亮星形圖標,再次點擊將會取消收藏並點滅。 |
|
7 |
帖子分 類 |
主頁 |
點擊主頁上顯示的分類按鈕,可篩選所要查看的 分類下的帖子。 |
|
8 |
搜索帖 子 |
主頁 |
點擊搜索框,輸入關鍵字,查詢相關的帖子。 |
|
9 |
查看推 薦信息 |
主頁 |
在滾屏區域左右滑動能夠切換推薦內容,點擊圖 片打開該信息的來源連接。 |
|
10 |
新建帖子 |
主頁、編輯帖子頁 |
點擊主頁右上角的「+」按鈕,進入「新建帖子」 頁面。選擇商品類別,填寫標題,名稱,來源, 單價,預期團購人數,截止時間,描述和圖片。左上角能夠「取消」按鈕發帖並回到主頁。點擊 右上角圖標發帖並回到主頁。 |
|
11 |
菜單 |
主頁,菜單頁 |
點擊主頁左上角的「菜單」按鈕,滑出菜單選項。包括用戶名、「個人帖子」、「個人足跡」、「我 的收藏」、「設置」。 |
|
12 |
查看我的信息 |
菜單頁、我的信息頁 |
點擊菜單頁的用戶名和頭像區域,打開「我的信息」頁面,查看我的詳細信息、頭像、暱稱、性別、生日、職業、學校和我的說明。點擊左上角「<」按鈕返回菜單頁,點擊右上角「編輯」按 鈕編輯。 |
|
13 |
編輯我的信息 |
我的信息頁、編輯我的信息頁 |
我的信息頁點擊右上角「編輯」按鈕進入我的信 息編輯頁。更換頭像,修改暱稱、性別、生日、職業、學校和我的說明。點擊左上角「<」返回 我的信息頁面,點擊右上角「保存」按鈕保存更 改並返回我的信息頁面。 |
|
14 |
查看「正在進行」 的帖子 |
主頁、菜單頁、正在進行頁 |
主頁點擊「我」發佈的帖子進入帖子詳情(正在進行)。菜單頁點擊「個人帖子」按鈕進入正在進行帖子頁面。查看列表,列表顯示帖子的描述、剩餘時間、圖片,帶有「刪除」、「修改」、「完成」按鈕。點擊帖子信息區域進入帖子詳情頁(正在進行)。點擊下方導航欄進入相應頁面。點擊 左上角「<」按鈕返回菜單頁。 |
|
15 |
刪除「正在進行」 帖子 |
正在進行帖子頁,帖子詳情頁 (正在 進行) |
點擊正在進行帖子頁面中的列表中的「刪除」按鈕或帖子詳情(正在進行)頁的「刪除」按鈕, 彈出帶有「取消」和「肯定」按鈕、「肯定要刪除嗎?將不可恢復」提示的提示框,點擊「取消」 取消操做,點擊「肯定」執行刪除操做。 |
|
16 |
標記帖子完成 |
正在進行帖子頁,帖子詳情頁 (正在 進行) |
點擊正在進行帖子頁列表中的「完成」按鈕或帖子詳情(正在進行)頁的「完成」按鈕,將該帖子移至已完成帖子頁面。 |
|
17 |
編輯「正在進行」 帖子 |
正在進行頁、帖子詳情頁(正在 進行) |
點擊正在進行帖子頁列表中的「編輯」按鈕或帖 子詳情頁的「編輯」按鈕,進入帖子編輯頁面。 |
|
18 |
查看「過時」的帖子 |
菜單頁、正在進行帖子頁、過時帖子頁 |
菜單頁點擊「個人帖子」按鈕進入正在進行帖子頁面。點擊導航欄「過時」按鈕進入過時帖子頁面。顯示過時帖子的列表,列表包含帖子描述和圖片,帶有「刪除」按鈕,點擊帖子查看詳情(不可編輯)。點擊下方導航欄進入相應頁面。點擊左上角「<」按鈕返回菜單頁。 |
|
19 |
刪除「過時」的帖子 |
過時帖子頁、帖子詳情頁(不可 編輯) |
點擊過時帖子頁面列表中的「刪除」按鈕或帖子詳情頁(不可編輯)中的「刪除」按鈕,彈出帶有「取消」和「肯定」按鈕、「肯定要刪除嗎? 將不可恢復」提示的提示框,點擊「取消」取消 操做,點擊「肯定」執行刪除操做。 |
|
20 |
查看「已完成」的帖子 |
菜單頁、正在進行帖子頁、已完成帖子 頁 |
菜單頁點擊「個人帖子」按鈕進入正在進行帖子頁面。點擊導航欄「已完成」按鈕進入已完成帖子頁。顯示已完成的帖子列表,列表包含帖子描述和圖片,帶有「刪除」按鈕,點擊帖子查看詳情(不可編輯)。點擊下方導航欄進入相應頁面。 點擊左上角「<」按鈕返回菜單頁。 |
|
21 |
刪除「已完成」的帖子 |
已完成帖子頁、帖子詳情頁(已 完成) |
點擊已完成帖子頁面列表中的「刪除」按鈕或者帖子詳情頁(已完成)中的「刪除」按鈕,彈出帶有「取消」和「肯定」按鈕、「肯定要刪除嗎? 將不可恢復」提示的提示框,點擊「取消」取消 操做,點擊「肯定」執行刪除操做。 |
|
22 |
個人足跡 |
菜單頁、個人足跡頁 |
點擊菜單頁個人足跡,進入個人足跡頁面。顯示最近瀏覽的帖子,包括商品圖片,標題,剩餘時間。點擊可查看詳情。點擊「刪除」按鈕執行刪 除操做。點擊左上角「<」按鈕返回菜單頁。 |
|
23 |
個人收藏 |
菜單頁、個人收藏頁 |
點擊菜單頁個人收藏進入個人收藏頁面。顯示我收藏的帖子,包括商品圖片,標題。點擊可查看詳情(他人帖子)。點擊「刪除」按鈕取消收藏。 點擊左上角「<」按鈕返回菜單。 |
|
24 |
設置 |
菜單頁、設置頁 |
點擊菜單頁「設置」區域進入設置頁,包含「版本信息」、「意見反饋」、「切換用戶」。設置 頁點擊左上角「<」按鈕返回菜單頁。 |
|
25 |
查看 版本信息 |
設置頁 |
點擊設置查看「版本信息」行下的版本號 |
沒有新頁面 |
26 |
意見反饋 |
設置頁、意見反饋頁 |
點擊設置頁的「意見反饋」選項進入意見反饋詳 情頁。填寫反饋內容和聯繫方式,點擊「提交」 按鈕提交反饋信息。點擊版本信息詳情頁左上角 「<」返回設置頁。 |
|
27 |
切換用 戶 |
設置頁 |
點擊「切換用戶」選項退出登陸,回到開始頁面。 |
|
4.4.2 管理員類
序號 |
功能名 稱 |
操做界 面 |
詳細操做 |
備註 |
1 |
登陸 |
登陸 界 面 |
打開 網站 後,在「用戶名」輸入框填入管理員帳 號或者手機號,在「密碼」輸入框輸入密碼,點 |
|
|
|
|
擊登陸按鈕進行登陸。若是密碼錯誤或管理員帳 |
|
|
|
|
號錯誤,彈出提示「管理員不存在或者密碼錯 |
|
|
|
|
誤!」。 |
|
2 |
刪除帖 |
正在審 |
點擊正在審覈帖子頁面中的列表中的「刪除」按 |
|
|
子 |
核、詳細 |
鈕或詳細信息頁的「刪除帖子」按鈕,彈出帶有 |
|
|
|
信息 |
「取消」和「肯定」按鈕、「肯定要刪除嗎?將 |
|
|
|
|
不可恢復」提示的提示框,點擊「取消」取消操 |
|
|
|
|
做,點擊「肯定」執行刪除操做。 |
|
3 |
經過審 |
正在審 |
點擊正在審覈帖子頁面中的列表中的「經過」按 |
|
|
核 |
核、詳細 |
鈕或詳細信息頁的「經過」按鈕,彈出帶有「取 |
|
|
|
信息 |
消」和「肯定」按鈕、「肯定要經過嗎?將不可 |
|
|
|
|
恢復」提示的提示框,點擊「取消」取消操做, |
|
|
|
|
點擊「肯定」執行經過審覈操做。 |
4.5 其餘驗收標準
暫無