Violet音樂社區需求分析說明書

目錄

• 1、引言
  • 1.1 編寫目的
  • 1.2 開發背景
  • 1.3 開發工具
• 2、項目需求
  • 2.1 角色定義
  • 2.2 模塊劃分
  • 2.3 功能概述
    • 2.3.1 管理員
    • 2.3.2 普通用戶
    • 2.3.3 遊客
  • 2.4 數據流圖
• 3、前端頁面
• 4、軟件要求
  • 4.1 性能要求
  • 4.2 屬性要求
• 5、人員分工

界面原型程序demo：http://kealine.top/SE/demo/

1、引言

1.1 編寫目的

此文檔爲「Violet」音樂社區開發團隊的指導文檔。開發人員閱讀此文檔有助於團隊間合做，同時提升軟件質量。開發者應仔細閱讀此文檔，根據文檔需求來進行開發，達到預期功能與效果。

1.2 開發背景

音樂是一門藝術，是由有組織的樂音來表達人們情感、反映人類現實生活情感的藝術。現代科技的發展使得人們能夠利用網絡隨時隨地的享受音樂，然而在當今互聯網卻不多有一個以音樂爲媒介的社交平臺。本開發團隊想以「音樂+社交」的形式，開發一款集聽歌、交友和討論爲一體的網上社區——「Violet」音樂社區。Violet多指紫羅蘭，也可形容羞怯的人，本團隊旨在經過此平臺加強人們對音樂的交流，同時拉近人與人之間的距離。

1.3 開發工具

	前端	後端
開發語言	JavaScript	Python
框架	Vue.js	Flask

2、項目需求

2.1 角色定義

角色	定義
管理員	可對音樂庫進行樂曲的上傳和下架，對普通用戶進行管理，對用戶動態和圈子進行管理。
普通用戶	能夠搜索音樂並播放而且關注其餘用戶，能夠發佈動態和建立圈子。
遊客	能夠在曲庫中搜索音樂並播放，可是沒法瀏覽用戶建立的圈子和發佈的動態，自身也沒法發佈動態和建立圈子。

2.2 模塊劃分

「Violet」音樂社區的功能模塊可基本分爲兩個方面：音樂模塊以及社交模塊。模塊示意圖以下圖所示：

2.3 功能概述

2.3.1 管理員

• 添加歌曲到曲庫：添加歌曲（包括：歌曲名稱，歌手，歌曲圖片或歌手圖片）到曲庫中。

• 下架歌曲：應一些版權方要求或歌詞中含有一些不良信息或敏感信息而從曲庫中下架歌曲。

• 限制用戶評價歌曲：當某用戶發佈的評價被其餘用戶舉報（使用不文明詞彙，發佈不良信息或敏感信息，發佈反動言論）且覈實後，封禁相應用戶在一段時間內沒法評價全部歌曲，時間長短視情節嚴重改變。

• 限制用戶發佈動態：當某用戶發佈的動態被其餘用戶舉報（使用不文明詞彙，發佈不良信息或敏感信息，發佈反動言論）且覈實後，封禁相應用戶在一段時間內沒法發佈動態，時間長短視情節嚴重改變。

• 限制用戶建立圈子：當某用戶建立的圈子被其餘用戶舉報（圈子內討論不正常信息，組織非法活動，組織違反道德底線的活動）且覈實後，封禁相應用戶在一段時間內沒法建立圈子，時間長短視情節嚴重改變。

• 解散圈子：當某用戶建立的圈子被其餘用戶舉報（圈子內討論不正常信息，組織非法活動，組織違反道德底線的活動）且覈實後，管理員能夠解散該圈子。

• 刪除帖子：當某用戶發佈的帖子被其餘用戶舉報（帖子內發佈不正常信息，組織非法活動，組織違反道德底線的活動）且覈實後，管理員能夠解散該帖子。

• 刪除用戶動態：當某用戶發佈的動態被其餘用戶舉報（使用不文明詞彙，發佈不良信息或敏感信息，發佈反動言論）且覈實後，管理員能夠刪除該動態。

2.3.2 普通用戶

• 修改我的信息：用戶能夠在我的主頁上修改我的信息（包括我的暱稱，密碼，頭像，我的介紹）。
• 搜索歌曲：用戶在首頁搜索欄輸入歌曲名稱，網頁顯示歌曲中包含用戶輸入的搜索信息的歌曲。
• 搜索相應歌手的歌曲：用戶在首頁搜索欄輸入歌手名稱，網頁返回該歌手下對應的歌曲。
• 瀏覽評價：用戶在點擊具體某一首歌以後能夠在網頁下方瀏覽該歌曲的相應的評論。
• 評價歌曲：用戶在點擊具體某一首歌以後能夠在網頁下方對該歌曲進行相應的評論。
• 用戶關注：用戶在曲庫的評價頁面上，經過瀏覽其餘用戶的評論尋找志同道合的人進行關注。
• 取消關注： 用戶能夠在我關注的人頁面或者被關注的人的主頁進行取消關注用戶功能。
• 建立動態：用戶能夠在我的主頁上發佈動態（可添加圖片，動態只能被你本身和關注你的人看見）。
• 瀏覽動態： 用戶能夠進入其餘用戶動態頁面，瀏覽其餘用戶的動態（只有關注當前用戶才能瀏覽該用戶動態，不然只能查看他的我的介紹信息）。
• 評論動態： 用戶能夠對本身的動態或者關注的人的動態進行評價
• 建立圈子： 用戶能夠建立一個小組形式的圈子羣，而且邀請關注的人加入該圈子。
• 發佈帖子： 用戶能夠在本身加入的圈子中發佈帖子，可供別的用戶評論。
• 評論帖子： 用戶能夠在本身發佈的帖子或者是其餘用戶發佈的帖子下方進行評論，也可對其餘用戶的評論進行回覆。
• 邀請用戶加入圈子： 能夠邀請關注的人加入圈子

2.3.3 遊客

• 搜索歌曲： 遊客在首頁搜索欄輸入歌曲名稱，網頁顯示歌曲中包含遊客輸入的搜索信息的歌曲。
• 搜索相應歌手的歌曲： 遊客在首頁搜索欄輸入歌手名稱，網頁返回該歌手下對應的歌曲。
• 瀏覽評價： 遊客在點擊具體某一首歌以後能夠在網頁下方瀏覽該歌曲的相應的評論。
• 註冊帳號：遊客能夠在頁面上註冊帳號變成用戶從而進行具有一些用戶的權限。

2.4 數據流圖

3、前端頁面

「Violet」平臺選用PC網頁端，要求總體界面簡潔、風格統一，且與用戶有良好的交互性。該平臺主要有如下界面：

• 登錄界面

用於用戶驗證。要求：界面簡潔明瞭。

• 主頁面

用於展現熱門歌曲、歌單、專輯，並提供索引欄和播放欄。要求：界面簡潔、主題色調醒目。

• 曲庫搜索頁面

用於用戶搜索歌曲、歌單、專輯，同時提供熱門搜索連接。要求：界面簡潔明瞭。

• 動態頁面

用於展現用戶所關注的人發的動態

• 圈子頁面

用於展現該平臺上存在的圈子，可經過分類索引欄找到不一樣類別的圈子（如華語、搖滾、情歌等）。要求：界面簡潔明瞭、佈局合理、用戶易上手。

• 我的主頁

用於展現用戶我的所發的動態、關注的人、加入的圈子。要求：界面簡潔明瞭，佈局合理。

（*注：若在開發過程當中遇到特殊需求，可合理添加其餘頁面）

4、軟件要求

4.1 性能要求

本平臺主要針對普通用戶，對時間要求度不高，但仍要保證系統穩定快速地運行，同時面對不一樣瀏覽器不會產生兼容性問題，具體要求以下：

• 數據精確性

要求在用戶操做過程當中傳輸的數據準確無誤。

• 時間特性

要求系統即便在多用戶同時訪問、負載較高的狀況下，也能對用戶的操做作出快速響應，對數據的變化作出快速更新。

• 適應性

要求在不一樣性能的終端，不一樣的網絡環境，不一樣的瀏覽器上都能正常運行，不會產生兼容性問題。

4.2 屬性要求

本平臺在使用過程當中，不會對用戶系統形成傷害，不會非法竊取用戶我的信息，更不會在未經容許的狀況下訪問除平臺數據庫外任何用戶的文件。

• 安全性

該平臺具備用戶登陸驗證功能，對嘗試登錄失敗次數超過上限的帳號，進行暫時拒絕登錄，同時經過綁定的郵箱或手機提醒用戶本人該操做。

• 完整性

在遇到突發事故，如硬件損壞、停電等，平臺數據不會丟失。

• 可維護性

平臺的不一樣模塊之間應具備良好的隔離性，產生bug時能夠精肯定位問題模塊，且不會影響其餘模塊的正常運行。

• 易使用性

平臺界面的功能和索引等元素應具備良好的交互性，便於用戶接受，同時提供必要的幫助文檔。

5、人員分工

姓名	學號	具體分工
周佳輝 (組長)	31701030	界面原型，前端開發
羅賢哲	31701013	界面原型，前端開發
孫華陽	31701015	數據庫設計，後端開發
陳天翼	31701007	數據流圖繪製，後端開發
董騰然	31701009	需求文檔撰寫，後端開發
周家豪	31701059	需求文檔撰寫，後端開發