软件需求说明书

目录

1. 介绍
   1.1 编写目的
   1.2 文档范围
   1.3 文件概述
   1.4 参考资料
2. 项目介绍
   2.1 项目背景
   2.2 项目目标
   2.3 项目范围
3. 应用环境
   3.1 系统环境
4. 功能规格
   4.1 系统角色（Actor）分析
   4.1.1 学生
   4.1.2 普通用户
   4.1.3 教师
   4.1.4 系统管理员
   4.2 系统主用例图（Use Case）
   4.3 子系统
   4.3.1 注册系统
   4.3.2 登录系统
   4.3.3 班级系统
   4.3.4 单词识别查询
   4.3.5 生词库系统
   4.3.6 题库系统
   4.4 非功能性需求
   4.4.1 界面需求
   4.4.2 响应时间需求
5. 需求变更
6. 产品提交
7. 实现约束

1.介绍

1.1编写目的

该文档描述了Learning path软件系统的功能和性能的需求，作为对该项目在概要设计阶段的设计输入。

本文档的预期读者包括：

设计开发人员

项目管理人员

测试人员

用户

1.2 文档范围

该文档的目的是解决整个项目系统中“做什么”的问题。对于开发技术在这里并没有涉及，而主要是通过建立模型的方式来描述用户的需求为，客户、用户、开发方等不同参与方提供一个交流的平台。

1.3 文件概述

本文档描述了该产品的功能。它描述了非正式的需求，为技术需求规范建立上下文。本文档的需求规范部分，主要是为开发人员编写的，并且用技术术语描述了产品功能的细节。稳当的两个部分完整地描述了同一个产品，但是针对不同的用户，因此使用不同的描述。

1.4 参考资料

《软件工程案例教程软件项目开发实践
第三版》 韩万江等 机械工业出版社

2. 项目介绍

2.1 项目背景

在当今世界，英语仍然是被广泛使用的。目前，市场上的大部分词典软件所提供的拍照功能，同样是用了图片处理识别技术，但是市场上的大部分APP提供的仅是单句翻译或者全文翻译，这一点实际上并不利于英语学习者，因为这些APP所提供的翻译功能翻译出的结果比较模糊，若是优秀一些的翻译功能，智能识别出的翻译相对原意进行了一定的美化，这种功能并不利于英语学习者具体了解每一个单词的意思。英语学习者想要学习英语，更需要的是记住单词的意思，单词是句子的基础，句子才能够构建出文章，由此可知记单词的重要性。同时，这些APP也不会根据用户的使用情况进行分析，从而得到一些可用的数据。

2.2 项目目标

本项目研究的目的主要是让用户在面对一篇文章的多个生词时，能够更快速的查询到每一个生词的释义，并通过软件的大数据分析，了解自己的不足之处。

本项目的主要研究内容有：

1、通过图像识别技术识别出文章中的每一个单词，在用户点击生词时，能够出现该生词的释义及例句，并导出该生词在哪张试卷（历年中高考英语试卷/四、六级真题、考研英语）出现，并导出包含该生词的题目；

2、通过编程让系统实现自动分析并识别出用户高频率查询的生词并存入自动生成的生词本中；

3、开发教师端及学生端，将两个端口联系在一起，教师端可以查询到学生端查询频率最高的单词及每个学生学习的情况。

2.3 项目范围

Learning path是一个基于Android/IOS的英语学习软件。这个软件将通过提供工具来协助用户学习英语，面对长篇大论的英文时，只需拍照识别即可查取生词，从而最大限度地提高学习英语的效率，避免手动查询带来的效率低下。结合题库和生词本收录，增强学习性。

本项目与目前市场上APP不同的有以下几点：

1.可以智能识别出一个句子或一篇文章中的单个单词，用户只需要点击自己想要了解的生词，软件会给出该单词的释义及相关利句，包括含有该单词的题目；

2.根据用户对于所查询单词的点击频率生成一份数据报告，并将点击频率较高的单词自动生成一个生词本，提供看词选意，选词填空，拼写单词三种记忆方式；

3.软件提供学生端及教师端，将两个平台搭建在一起，教师可以管理班级学生信息,系统会对班级内所有学生的数据进行分析，由此教师可以了解到学生使用该软件点击频率最高的生词，及这些生词衍生出的易错题。

3. 应用环境

3.1 系统环境

图3-1 系统环境

Learning path软件系统有三种用户参与者（教师、学生和普通用户），划分为单词识别查词、题库、单词分析三个部分。学生通过单词识别查词，即可显示出这个单词的释义、例句以及包含有该单词的题目，单词分析形成生词本以供复习。系统会自动对学生查词频率最高的单词及易错题目进行数据分析，并反馈到教师端口供教师查阅和参考。两种用户皆通过互联网访问软件，通过软件系统建立联系。普通用户则可仅使用单词识别查词功能。

4. 功能规格

项目的整体功能结构如图2所示.系统中主要角色是教师和学生，他们可以完成的功能如注册登录、拍照识别单词、等，系统维护的系统管理员也是一个必要的角色，系统中也存在普通用户的角色，他具有拍照识别单词功能。

图4-1 系统整体架构图

4.1 系统角色（Actor）分析

角色或者执行者(Actor)是指与系统产生交互的外部用户或者外部系统。本系统的使用角色主要分为普通用户、学生、教师和系统管理员四种。以下是对每个角色的详细介绍。

4.1.1 学生

学生可以通过软件拍照识别一整篇文章中的每一个单词，只需要动手点击一下自己不认识的单词，即可显示出这个单词的释义、例句以及包含有该单词的题目（拟计划建立一个高考、四级、六级真题及考研英语题库），若需要做含有该单词的题目增强记忆，只需点击“相关题目”即可以进入做题界面，系统会自带判断正误以及计时的功能，在答题后对用户的答题情况进行评估；

对于用户近期频繁点击的单词，可以根据用户自身选择的频率（例如：点击过一次或点击过三次）生成一个“生词本”，以供用户进行单词的复习，用户也可以在查询单词的下方点击“收录进生词本”。针对这些生词本，系统还可以生成单词记忆闯关的功能，记忆闯关的功能包括看词选意，选词填空，拼写单词三种记忆方式。

4.1.2 普通用户

普通用户不需要加入班级，直接登入并使用拍照识别单词，生词本等功能，与学生的区别仅在于是否加入了班级。

4.1.3 教师

教师可以在教师端口生成自己的班级，学生通过学生端口加入该班级，教师端可以对学生近期的学习情况进行查看，同时系统会自动对学生查词频率最高的单词及易错题目进行数据分析，并反馈到教师端口供教师查阅和参考。

4.1.4 系统管理员

系统管理员主要进行软件日常维护，更新数据库。

4.2 系统主用例图（Use Case）

系统由注册、登录、班级、单词识别、生词本、题库子系统组成。参与人员有教师、学生和普通用户，系统间不耦合，各自处理相应事务。具体系统主用例图如图3所示。

图4-2 系统主用例图

4.3 子系统

子系统由普通用户、学生和教师执行相关操作，普通用户不需要加入班级，直接登入并使用拍照识别单词，生词本等功能，与学生的区别仅在于是否加入了班级。

学生可拍照识别单词，查看单词释义、例句、题库，答题，使用生词本收录，单词记忆闯关，加入班级。

教师除普通用户功能外，还可以生成班级，查看学生查词单词频率反馈、学生易错题目反馈。

4.3.1 注册系统

角色:教师，学生，普通用户

目的：用户注册

用例描述：

(1)用户进入系统首页。

(2)系统显示注册界面，用户输入相关的身份信息，单击确定。

(3)用户名长度不足10位时，提示"用户名应为10位数字”，密码不足6位

或超过16位时，提示“密码必须为6位以上，16位以下”。

(4)系统经过后台确认数据合法后提示注册成功。

4.3.2 登录系统

角色:教师，学生，普通用户，管理员

目的:用户登录系统。

前置条件:用户身份为教师、学生、管理员、普通用户。

用例描述：

(1)用户进入系统首页。

(2)系统显示登录界面， 用户输入用户名和密码，单击确定。

(3)系统检查是否有此用户信息，若存在此用户，用户进入系统:若不存在

此用户，本页面显示相应的错误信息。

(4)不同身份登录详细说明:

游客:不出现人员管理功能栏，不出现班级功能。

学生:不出现人员管理功能栏，不出现班级管理功能栏。

教师:不出现人员管理功能栏。

管理员:不出现班级管理等相关功能栏。

4.3.3 班级系统

班级系统主要为了便于教师管理学生，查看学生学习情况反馈。学生仅可加入班级，教师可生成班级以及对班级成员进行管理。如下图4-3是本部分功能的用例图。

图4-3 班级系统用例图

角色：学生，教师

目的：便于教师管理学生，查看学生学习情况反馈

用例描述：

（1）教师生成班级，产生班级邀请码。

（2）学生输入班级邀请码申请加入班级，教师核对学生身份后同意进入，之后可查看系统对学生学习数据的反馈。

（3）班级内部有交流板块，用于师生提问答疑，教师有删除发言的权限。

4.3.4 单词识别查询

单词识别查询是软件的主要功能，所有用户都可使用，同时向教师端提供数据反馈。本功能部分的用例图如图4-4所示。

图4-4 单词识别查询用例图

角色：学生，教师，普通用户

目的：拍照选取单词，查词

用例描述：

（1）用户通过客户端使用相机拍摄想要查词的英语文段，软件会自动提取每个单词。

（2）每遇到用户想查询的单词，直接点击即可进入单词查询页面。该页面包括单词释义、例句、以及包含有该单词的题目。

（3）系统会自动对学生查词频率进行数据分析，并反馈查询频率较高的单词到教师端口供教师查阅和参考。

4.3.5 生词库系统

生词库系统同样提供所有用户使用，是查词的辅助功能，包括加入生词库及单词记忆两个板块。本功能用例图如图4-5所示。

图4-5 生词库系统用例图

角色：学生，教师，普通用户

目的：辅助单词记忆

用例描述：

（1）对于用户近期频繁点击的单词，可以根据用户自身选择的频率（例如：点击过一次或点击过三次）生成一个“生词本”，以供用户进行单词的复习，用户也可以在查询单词的下方点击“收录进生词本”。

（2）针对这些生词本，系统还可以生成单词记忆闯关的功能，记忆闯关的功能包括看词选意，选词填空，拼写单词三种记忆方式。

4.3.6 题库系统

题库系统提供学生和普通用户进行答题，同时向教师反馈本班级学生的答题情况。本功能用例图如图4-6所示。

图4-6 题库系统用例图

角色：学生，教师，普通用户

目的：辅助单词学习

用例描述：

（1）在单词查询页面，若用户需要做含有该单词的题目增强记忆，只需点击“相关题目”即可以进入做题界面，系统会自带判断正误以及计时的功能，在答题后对用户的答题情况进行评估。

（2）系统自动对班级学生错题进行数据分析，向教师反馈易错题目。

4.4 非功能性需求

4.4.1 界面需求

系统的界面要求如下:

1.页面内容:课程信息内容准确，术语和行文格式统-、 规范、明确，栏目、菜单设置和布局合理，传递的信息准确、及时。

2. 导航结构:页面具有明确的导航指示，且便于理解，方便用户使用。

3. 技术环境:页面大小适当，能用各种常用手机不同分辨率浏览;无功能错位。

4.艺术风格:界面、版面形象清新悦目、布局合理，字号大小适宜、字体选择合理，前后一致，美观大方；色彩和谐自然与内容相协调。

4.4.2 响应时间需求

当用户登录，进行任何操作的时候，系统应该及时的进行反应，反应的时间

在3秒以内。系统应能监测出各种非正常情况，如与设备的通信中断，无法连接数据库服务器等，避免出现长时间等待甚至无响应。

4.4.3可靠性需求

系统应保证7*24小时内不死机，保证多人可以同时在客户端登录，系统正常运行，正确提示相关内容。

4.4.4可扩展性需求

系统设计要求能够体现扩展性要求，以适应将来功能扩展的需求。

4.4.5系统安全性需求

网站有严格的权限管理功能，各功能模块需有相应的权限方能进入（如数师和学生具有不同的访问权限）。系统需能够防止各类误操作可能造成的数据丢失，破坏。防止用户非法获取网页以及内容。

5. 需求变更

需求变更控制过程图如图 5-1 所示：

图 5-1 需求变更控制变更图

从上图可以得到需求变更的控制过程为：客户递交变更，形成变更请求，变

更请求递交给开发小组，开发小组主要从技术实现的层面评估该变更请求是否合理，并对其进行成本和影响分析，接着将变更请求递交给产品开发小组产品开发小组从机构和战略以及经济的层面评估该变更请求是否合理，然后进行变更选择。

选择的结果有三种：一种是拒绝，也就是变更失败；一种是下个版本再修改，一种是变更通过。若变更通过，就需要修改相关需求，修改合同的相关信息，修改相应的项目计划。这样，需求变更的控制过程就结束了。

6. 产品提交

提交产品为：

（1） Learning path

（2） 数据库初始数据

（3） 系统开发过程文档

（4） 系统使用维护说明文档

7. 实现约束

系统的实现约束如下：

（1） 操作系统为：具有 java 虚拟机的操作系统

（2） 开发平台为：MyEclipse

（3） 数据库为：MySQL

（4） Web 服务器为：Tomcat

（5） 版本管理工具：Visual Source Safe 6.0

（6） 测试工具：JMeter 2.10