1.引言
1.1目的
該文檔是關於我們組的記事本安卓APP和網頁版本的功能和性能的描述,重點描述了系統的功能需求,並作為系統設計的主要輸入。
本文檔的預期讀者包括:需求分析人員,設計人員,開發人員,項目管理人員,測試人員,用戶。
1.2項目背景
項目名稱:記事本
項目的提出者:華中農業大學計科1703 CLJW小組
項目開發者:陳晗煜 王欣宇 金德鑫 李鎏洋
用戶:所有人
1.3縮寫說明
無
1.4術語定義
無
1.5參考資料
《軟件工程方法與實踐》——竇萬峰
1.6版本信息
修改編號 |
修改日期 |
修改后版本 |
修改位置 |
修改內容概述 |
1 |
2019-4-15 |
1.0 |
全部 |
完成第一次撰寫 |
2.任務概述
2.1系統定義
2.1.1項目來源及背景
本項目在小組成員集體討論時提出。在當下,記事本APP是每個人在手機上必不可少的軟件。每個人都會有各種各樣的瑣事,計划要隨手記錄,甚至會在手機或電腦上記日記或者隨筆。為了同時支持電腦和手機用戶,我們計划開發一個兼有web和android端的記事本軟件。這也是鍛煉自我,提高自學能力和動手能力的機會。
2.1.2項目目標
為了方便人們手機上隨手記事,電腦上整理資料的需求,並且網頁端和安卓端數據同步,同時滿足手機和電腦用戶,只要做出優美的界面,添加創新功能,該軟件一定能擁有廣闊的市場!
2.1.3系統整體結構
2.2運行環境
2.2.1設備環境
安卓手機,電腦
2.2.2硬件環境
安卓端對安卓手機的配置要求不高,只要能正常運行當前主流編程軟件的安卓手機,即可正常運行該app。
網頁端對電腦配置也要求不高,有正常主流瀏覽器即可。
2.2.3軟件環境
安卓端適用於當前主流安卓手機系統。
網頁端適配於當前主流的操作系統。
2.2.4網絡環境
不要求網絡。
2.2.5操作環境
安卓端安卓手機。
網頁端PC機。
2.2.6應用環境
2.3條件限制
2.3.1軟件開發工作的假定和約束
安卓界面在Android Studio上開發,需要JDK,SDK支持。
web界面在IntelliJ IDEA上開發,需要JDK支持。
2.3.2最終用戶、用戶的教育水平和技術專長
無特定要求
2.3.3軟件的預期使用頻度等
在記事時使用,使用頻率較高。
3.數據描述
3.1靜態數據
所有用戶的賬戶密碼
筆記本和筆記的名字
筆記和筆記本創建或修改的時間
筆記中的內容
廢紙簍中的內容以及刪除的時間
3.2動態數據
登錄輸入的信息
搜索欄中的輸入
創建筆記時輸入的名字以及編寫筆記時輸入的內容
3.3數據庫描述
采用Mysql數據庫,用PhpMyadmin進行數據庫管理
3.4數據字典
數據項名 |
代號 |
數據類型 |
數據長度 |
取值范圍 |
賬號 |
Username |
Varchar(10) |
10 |
6-10位 |
密碼 |
Password |
Varchar(10) |
10 |
6-10位 |
筆記本名稱 |
Bname |
Varchar(10) |
10 |
|
筆記名稱 |
Nname |
Varchar(10) |
10 |
|
筆記內容 |
Ntext |
Varchar |
|
|
筆記創建時間 |
Ntime |
Time |
|
|
筆記本創建時間 |
Btime |
Time |
|
|
筆記刪除時間 |
NDtime |
Time |
|
|
筆記本刪除時間 |
BDtime |
Time |
|
|
筆記是否刪除 |
Nexist |
TinyInt(1) |
|
0,1 |
筆記本是否刪除 |
Bexist |
TinyInt(1) |
|
0,1 |
4.功能需求
4.1功能分析
4.1.1系統功能組成
用戶
管理
編輯
搜索
4.1.2功能編號和優先級
功能編號 |
名稱 |
優先級 |
描述 |
主要發起者 |
1 |
用戶 |
次要 |
注冊登錄注銷賬戶 |
用戶 |
2 |
管理 |
重要 |
添加修改重命名 |
用戶 |
3 |
編輯 |
重要 |
編寫筆記 |
用戶 |
4 |
搜索 |
重要 |
搜索筆記筆記本 |
用戶 |
4.1.3功能定義
用戶:對系統用戶的身份信息進行增加、刪除、修改、等操作,是系統的重要組成部分。
管理:對筆記或者筆記本進行添加,刪除,重命名操作。
編輯:編寫自己的筆記內容。
搜索:可以通過筆記或者筆記本的名字搜索相關內容。
4.2功能划分
4.2.1功能說明
注冊用戶:創建新用戶。
更新用戶:更新用戶信息。
注銷用戶:刪除用戶信息。
管理筆記本:可以創建,刪除,重命名筆記本,里面可以編寫若干條筆記,相當於對筆記進行分類。
管理筆記:可以創建,刪除,重命名筆記,刪除的筆記會到廢紙簍中,可以恢復,也會定期自動清除廢紙簍。可以按時間顯示所有筆記,也可以顯示某筆記本中的筆記。可以為筆記添加提醒功能,在指定時間內提醒用戶指定事件。
編輯筆記:可以在筆記中添加名字,內容。內容可以是文字,圖片,可以修改文字的顏色,字體,大小,可以添加一級標題,二級標題,三級標題,四級標題。
搜索筆記:可以通過筆記或者筆記本的名字搜索相關內容。
4.2.2 詳細描述
采用活動圖的方法建立模型。
登錄頁面系統活動圖:
管理界面:
筆記編寫界面:
5.性能需求
5.1數據精確度
要按照嚴格的數據格式輸入,不能輸入非法字符,否則系統不給予響應進行處理。
查詢時要保證准確率為100%,所有包含查詢關鍵字的記錄都應能查到,不能有遺漏。
5.2時間特性
操作響應時間在2s以內。
5.3適應性
安卓端適應主流安卓系統
網頁端適應Windows和Linux系統
6.運行需求
6.1用戶界面
6.1.1界面風格
風格簡潔大氣,氣質高雅,色彩明麗。
6.1.2界面描述和樣式
登錄界面
注冊界面
筆記管理界面
筆記編輯界面
設置界面
6.2硬件接口
不需硬件接口支撐
6.3軟件接口
安卓端運行於Android系統
網頁端運行於主流瀏覽器
6.4故障處理
正常使用時不應出錯,若運行時遇到錯誤,退出程序后自動重啟,並向開發小組發送錯誤信息。
7.其他要求
7.1檢測或驗收標准
數據上傳失誤的可能性低於5%
7.2可用性、可維護性、可靠性、可轉換性、可移植性要求
程序故障率低於5%;由后台管理員隨時監控更新,可根據需求不斷完善,可維護性較高。
軟件要求模塊設計,設備驅動可更換
安卓端軟件可以在不同版本的Android系統上運行,軟件支持不同品牌的移動設備,例如華為、vivo、oppo、榮耀、中興等。
網頁端可以在不同版本的瀏覽器上運行。
7.3安全保密性要求
用戶個人信息存儲於后台數據庫中,不會對外公開展示:管理員也將實時監控系統的使用,保證用戶信息安全。
7.4開發要求
合適的Android Studio和IntelliJ IDEA版本
支持軟件,包括操作系統、編譯程序、測試軟件等按照黑盒測試方法設計測試用例進行驗收。