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版本
支持软件,包括操作系统、编译程序、测试软件等按照黑盒测试方法设计测试用例进行验收。