可行性分析报告
笔迹本项目组
- 概述：
现代大学生使用电子化方式记录课堂笔记不失为一种时髦的做法。基于此，同学们在上课听讲的过程中一定会需要记笔记，记笔记通过拍照或者手写的方式来进行记录。笔记可以以照片作为留存，以防纸质的丢失。到期末复习时，可以一键导出。
- 项目分析：
如今，学生作为一个庞大的群体，但许多笔记软件却并不关注这个群体。因为学生的消费能力有限，所造成的利益无法与办公群体相媲美。市面上的许多笔记软件对学生来说并不友好。学生需要的是笔记的复习和笔记内容的完善性，是需要不时复习的。而不是把很多有关联的东西聚合在一起。办公群体在乎的是广度和长期储存，学生需要的是深度和短期储存。
- 可行性分析：
3.1 成本/效益分析结果：效益>成本
1) 本软件可以替代基本的记事本软件，可以做基本的笔记记录；
2) 支持导出功能，可以给用户带来更高的便利性；
3) 轻量化应用，成本可以控制的更低。
3.2 技术可行性：基础功能开发任务
1) 本软件可以在Windows下实现记笔记的功能并支持导入图片；
2) 手机端app技术较有难度；
3) 同步功能的应用实现。
3.3 操作可行性：软件能迅速被接受
1) 操作简单：轻量级应用，上手轻松；
2) 导出方便：一键式导出，快捷高效。
- 可行性分析的结论：
根据以上对项目的可行性分析，该项目可以立即进行
软件需求规格说明书
笔迹本项目组
- 概述
1.1. 编写目的
编写此文档的目的是进一步定制软件开发的细节问题，希望能使本软件开发工作更具体。为了使用户、软件开发者及分析和测试人员对该软件的初始规定有一个共同的理解，它说明了本软件的各项功能需求、性能需求和数据需求，明确标识各项功能的具体含义，阐述实用背景及范围，提供客户解决问题或达到目标所需要的条件或权能，提供一个度量和遵循的基准。具体而言，编写软件需求说明的目的是为所开发的软件提出：
1.1.1. 软件设计总体要求，作为软件开发人员、软件测试人员相互了解的基础；
1.1.2. 功能、性能要求，数据结构和采集要求，重要的接口要求，作为软件设计人员进行概要设计的依据；
1.1.3. 软件确认测试的依据。
1.2. 编写依据
依据“笔迹本”软件的NABCD,方案书与策划书。
1.3. 术语与缩略词
| 术语、缩写及符号 |
解释 |
| SREM |
software requirement engineering methodology 软件要求工程方法学 |
| SRI |
SIP Relay Interface, SIP传递的接口 |
| RTM |
Reliability Test Module ,可靠性测试模块 |
| MVC |
Model-View-Controller模式 |
- 软件概要
2.1. 软件总体描述
现代大学生使用电子化方式记录课堂笔记不失为一种时髦的做法。基于此，同学们在上课听讲的过程中一定会需要记笔记，记笔记通过拍照或者手写的方式来进行记录。笔记可以以照片作为留存，以防纸质的丢失。到期末复习时，可以一键导出。
软件的实体关系图如图所示。该笔记的用户主要为学生。笔记也在学生之间共享使用。
2.2. 软件设计约束及有关说明
软件设计的约束以及有关说明如下所示：
2.2.1. 开发环境：
Visual Studio，QT
2.2.2. 编程语言：
C，C++，C#
2.2.3. 遵循的规范：
软件的设计和开发过程需要严格按照合同要求，根据软件的设计方案来进行。软件开发过程应遵循软件工程规范，对过程和版本进行管理和控制。
2.2.4. 测试环境：
Windows下用Visual Studio在C/S结构的环境中测试。
2.2.5. 软件交付形式：
源文件及App。
2.2.6. 软件交付日期：
2018/07/05
2.3. 使用者特点
本软件主要在甲方工作环境中使用，使用者包括学生，开发人员。使用者在计算机的应用、使用上不存在障碍，都在计算机的操作和使用方面得到过相关的培训。
- 开发和运行环境
3.1. 硬件环境
笔迹本软件的运行环境为个人计算机。详细要求见下表：
软件运行环境硬件要求
| 需求名称 |
详细要求 |
| CPU |
Intel Pentium II或同级CPU及以上 |
| 内存 |
2G及以上 |
| 硬盘 |
剩余50MB及以上 |
3.2. 支持软件环境
| 操作系统 |
是否支持 |
| Windows XP |
是 |
| Windows XP Vista |
是 |
| Windows 7 |
是 |
| Windows 8 |
是 |
| Windows 10 |
是 |
- 详细需求
4.1. 性能需求
4.1.1. 时间特性要求
4.1.1.1. 软件启动时间
不高于1800毫秒；
4.1.1.2. 系统实时响应时间：
软件使用过程中，对用户在各个功能模块的鼠标点击、键盘输入等操作事件的响应时间需在视用户配置的差异在能够接受的范围之内，一般小于1秒。
4.1.1.3. 数据的转换和传送时间：
对软件不同模块间的数据交互，要求数据的转换和传送时间不得超过1秒。
4.1.1.4. 数据更新时间：
不高于1秒。
4.2. 功能需求
经过多次需求调研，现提出“笔迹本”软件的功能需求。“笔迹本”软件包括文本编辑、网络同步通信等模块，
4.2.1 软件的用例图如图所示：
4.2.2 “笔迹本”软件的数据流程图：
4.2.3 “笔迹本”软件的状态活动图：
4.3. 数据需求
4.3.1. 数据采集的要求：
4.3.1.1. 输入源：键盘，鼠标和语音输入；
4.3.1.2. 输入介质和设备：键盘，鼠标和麦克风。
4.3.2. 数据输出要求：
4.3.2.1. 输出介质和设备：显示器，文件。
- 故障处理需求
5.1. 软件运行故障
在使用软件的过程中，当出现计算机断电，计算机内存不足等情况时，XXX软件将出现运行故障。运行故障发生时，软件的各个功能模块将无法正常使用，启动相关功能按钮都无法进行正常的操作。
对由于计算机断电引发的软件运行故障，用户在重新给计算机供电后，可以通过重新启动计算机，并启动“笔迹本”软件的方式恢复软件的正常运行与使用。对由于计算机内存不足引发的软件运行故障，建议暂时关闭软件。用户应检查并解决计算机内存不足的问题，内存使用情况正常后，“笔迹本”软件将恢复正常的运行与使用。
出现软件运行故障并进行修复后，应确保“笔迹本”软件功能的完整性，不能发生因软件运行故障而导致工具无法继续使用的情况。
5.2. 软件使用故障
在软件的使用过程中，如果出现软件使用故障，应当具有报警信息提示。
5.2.1. 当软件依赖的文件损毁或丢失时，软件以对话框的形式进行提示，报告损毁或丢失的文件等相关错误，以帮助用户及时修复软件的正常功能。
5.2.2. 对软件需要用户输入项的情况，如果发生缺少输入项、输入项格式错误或不符合规则等情况，软件应以合理的方式予以提示。
5.2.3. 为了防止用户由于未及时保存而导致信息丢失的情况，软件提供定时保存机制，每隔一定时间自动对信息进行保存，从而保证用户数据的安全。
- 质量需求
6.1. 软件的功能实现必须符合常用的主流软件的使用方法和操作习惯。
6.2. “笔迹本”工具的需要满足操作简单的要求，能够使用户没有障碍的使用该工具进行一系列的开发工作。
6.3. 要求可配置型强，便于使用者对工具的使用以及定制。
6.4. 采用可行、合理、高效的方式进行开放性的设计和实现。
6.5. 软件具有很强的适应能力，并且便于维护，不仅能很好的满足当前的需求，而且应当为后期可能的开发的工作提供很好的扩展和维护接口。
- 其它需求
7.1. 易用性需求：
作为一款笔记本软件，“笔迹本”软件的设计和实现遵循易用性原则，工具的安装和入门，工具的用户界面布局，使用工具的操作方式等方面都应符合主流文本编辑软件的设计风格与要求。
7.2. 安全性需求：
为了对软件的安装和使用进行统一的管理，安装“笔迹本”后，对于文本的管理需要得到授权才能使用该软件。软件采用激活码-注册的方式达到这一要求。启动并使用软件时，应对软件的授权信息进行检查，缺少授权信息情况软件将自动关闭。
详细设计文档
笔迹本项目组
1.0概述
本软件名称笔迹本。主要数据为文本和图片，软件对象为学生。 软件以课程为线索把笔记串联起来。笔迹本主要输入为文本，图片，输出为有顺序的课程笔记本，也可以输出单个的笔记。主要功能有导入导出，多人协作，共享，笔记复习。
2.0数据设计
软件主要采用的文本格式为rtf，也称富文本格式（Rich Text Format，
一般简称为RTF）。它可以同时编辑文本和图片。大多数的文字处理软件都
读取和保存RTF文档。它是写字板的默认文档之一，但除了它以外，Word，
WPS Office、Excel等都可以打开RTF格式的文件。
3.0结构化设计
3.1 层次图：
3.2 结构图
3.3 构件说明
l 导入：导入指定格式文档
l 导出文件：可以导出一个文件夹，或导出一个文件。
l 导出链接，可以导出存在服务器上的文档的连接。
l 多人协作，通过同步把文档导入本地，再根据权限进行修改。
3.4类图：
根据结构图和层次图，可以把软件主要分为四个部分，登陆部分，课表部分，课程列表部分，多人协作部分。
第一部分，登陆界面，主要负责身份的认证，和权限的赋予。主要功能为，登陆，注册，忘记密码。
第二部分，课表部分，也即主界面，主要负责课程的管理，由课程的基类派生。主要功能为，管理课程，导入导出，共享，并进入下一个界面。
第三部分，课程列表部分，主要显示一个课程下的所有笔记，由笔记的基类派生出来。主要功能为，搜索，打开，添加，删除笔记。
第四部分，多人协作部分，主要是由多人合作完成笔记，从服务器上同步所有笔记，和列表相似。每个人都可以添加笔记，但只有管理员可以整理笔记。主要功能为权限判定搜索，打开，添加，删除笔记。
4.0用户界面设计
界面主要用qt，主要有三个，登陆界面，主界面，列表界面。
主界面以课表为形式，方便学生动态添加课程，和找到要记笔记的课程。删除课程时可以选择保留笔记，和删除笔记。
列表主要可以动态显示所有笔记，和缩略内容，并支持添加，删除笔记，和缩略内容预览。
