团队项目-结项-软件需求规格说明文档
by InspAlgo小组
注：本文档依据《软件工程基础(第2版)》胡思康编著 P58 的软件需求规格说明文档编写
一、软件需求规格说明
1.1 范围
1.1.1 标识
系统名称: BIT课程/BITCourse
版本号: alpha版(开发版)
1.1.2 系统概述
1.1.2.1 一般特性
提供BIT在校生发表关于课程及教师的评价，同时可以看到相互之间的评价。
1.1.2.2 系统开发、运行和维护的历史
目前系统还处于开发阶段，由于本课程结课，故本项目开发冻结。
| 系统开发历史 | 开发内容 |
|---|---|
| 13、14周 | 基本完成主页面的框架 |
| 15周 | 完成主页面的服务器部署 |
| 16周 | 在写前端需要和数据库交互的部分，同时进行本周课程最后一次汇报的整理 |
| 17周 | 继续修改数据库交互部分 |
| 18周 | 完成数据库交互的主要功能，能够从网页上添加评价信息及查询评价信息 |
1.1.2.3 项目利益相关对象
| 对象 | 名称 |
|---|---|
| 投资方 | InspAlgo小组 |
| 需方 | 授课教师 |
| 用户 | BIT在校生 |
| 开发方 | InspAlgo小组 |
| 支持机构 | / |
1.1.2.4 运行现场
| 当前的运行现场 | 计划的运行现场 |
|---|---|
| 网页 | 网页 |
1.1.2.5 其他相关文档
见《团队项目-结项-项目总结》的文档汇总
1.1.3 文档概述
1.1.3.1 文档用途
本文档适用于判断分析本项目的需求建模情况，为之后的需求变更及项目测试、结项等提供书面依据。同时也为之后的同学了解本项目提供参考。
1.1.3.2 文档内容
对系统需求的分析。
1.1.3.3 授权、保密或私密有关的要求
本项目使用MIT开源许可证进行授权许可。
MIT License
Copyright (c) 2018 InspAlgo
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1.1.4 基线
1.1.4.1 需求基线
满足本专业同学的选课评价功能，可以查询本专业的课程及教师评价，可以发表评价，可以登陆注册。
1.1.4.2 测试基线
由于目前还没有进入专门的测试阶段，所以就没有设定测试基线。
1.2 引用文件
无。
1.3 需求
1.3.1 所需的状态和方式
| 状态和方式 | 内容 |
|---|---|
| 空闲 | 页面不用任何响应 |
| 准备就绪 | 页面的一些功能正处于等待中 |
| 活动 | 功能响应 |
| 事后分析 | / |
| 培训 | 针对用户和管理员 |
| 降级 | / |
| 紧急情况 | 遇到网页的一些比较严重的bug时，需要重定向到临时网页 |
| 后备 | 其他功能的添加 |
1.3.2 需求概述
1.3.2.1 目标
1.3.2.1.1 本系统的开发意图、应用目标及作用范围
| 描述 | 内容 |
|---|---|
| 开发意图 | 为同学选课提供参考意见，也为教师进行教学改革提供意见 |
| 应用目标 | BIT在校生都能够积极的在本平台上发表评价，同时老师们在这个平台上也能够得到直观的课程教学反馈 |
| 作用范围 | BIT在校生及教师 |
1.3.2.1.2 本系统的主要功能、处理流程、数据流程及简要说明
| 描述 | 内容 |
|---|---|
| 主要功能 | 用户注册及登陆，发表、修改、删除提问及评价，查询评价 |
| 处理流程 | 先进入主页面查询入口，输入相关关键词后进入搜索结果汇总的一个页面，然后再点击进入一个具体的评价页面，也可以进入搜索结果汇总页面后发表提问，除去查询浏览以外的操作均需要登陆授权 |
| 数据流程 | 见活动图 团队项目-第16周汇报-设计分析 |
| 简要说明 | 见NABCD模型分析 团队项目-需求分析与NABCD模型 |
1.3.2.2 运行环境
| 计划运行环境 | 目前测试的运行环境 |
|---|---|
| 系统以网页的方式展现，所以应能够在所有能够连接互联网的平台均可访问，主要是PC段和手机及平板的移动端。 | 由于在开发过程中发现现有的网页框架在移动端出现部分功能失效情况，所以现在主要是在PC端访问网页。 |
1.3.2.3 用户的特点
| 用户的特点名称 | 内容 |
|---|---|
| 身份 | BIT在校生 |
| 行为 | 查询课程评价、发表课程评价 |
1.3.2.4 关键点
- 提升系统交互流程性
- 评价内容的获取
- 如何引导大家积极评论
- 如何保证评价的优质性
1.3.3 需求规格
1.3.3.1 软件系统总体功能
提供BIT在校生对课程及教师的评价，主要由学生自行发表评论意见。同时提供查询功能。
1.3.3.2 软件子系统功能
暂无设计。
1.3.3.3 描述约定
| 提供的功能 | 目标 |
|---|---|
| 评价查询 | 能够从数据库中查找到相关信息，可以显示部分关键词 |
| 提问 | 发表关于课程或教师的评价的提问 |
| 评价 | 针对提问的问题进行回答评价 |
| 数据录入 | 主要是针对提问和评价模块的数据存入数据库中 |
1.3.4 软件配置项能力需求
由于在建模设计时并未考虑到软件配置项问题，同时课堂上也并未着重介绍过相关内容，故本文档关于此部分内容暂无。
1.3.5 软件配置项的外部接口需求
由于在建模设计时并未考虑到软件配置项问题，同时课堂上也并未着重介绍过相关内容，故本文档关于此部分内容暂无。
1.3.6 软件配置项内部接口需求
由于在建模设计时并未考虑到软件配置项问题，同时课堂上也并未着重介绍过相关内容，故本文档关于此部分内容暂无。
1.3.7 软件配置项内部数据需求
由于在建模设计时并未考虑到软件配置项问题，同时课堂上也并未着重介绍过相关内容，故本文档关于此部分内容暂无。
1.3.8 适应性需求
需要用户有对网页有较好兼容性的浏览器，以防止页面失效。目前推荐使用Chrome、Firefox。同时应该是从PC端访问，因为在目前的开发测试中发现移动端网页不能完全加载，部分特效失效，但主要功能还可以使用。
1.3.9 保密性需求
由于本项目使用MIT开源许可证进行授权许可，故对保密性没有要求。
1.3.10 保密性和私密性需求
由于本项目使用MIT开源许可证进行授权许可，故对保密性和私密性没有要求。
1.3.11 软件配置项的环境需求
由于在建模设计时并未考虑到软件配置项问题，同时课堂上也并未着重介绍过相关内容，故本文档关于此部分内容暂无。
1.3.12 计算机资源需求
1.3.12.1 计算机硬件需求
请从可连接互联网的PC端访问。
1.3.12.2 计算机硬件资源利用需求
能够正常运行现代主流浏览器即可，如Chrome、Firefox。
1.3.12.3 计算机软件需求
支持主流浏览器运行即可。
1.3.12.4 计算机通信需求
能够正常访问互联网即可。
1.3.13 软件质量因素
- 数据结构设计的不够合理
- 服务器负荷有限
- 前端交互逻辑与后端有部分冲突
- 不能够较好的支持并发
1.3.14 设计和实现的约束
1.3.15 数据
| 名称 | 来源 |
|---|---|
| 提问描述数据 | 用户以及管理员 |
| 评价数据 | 用户以及管理员 |
1.3.16 操作
主要有基本的网页查询、发表操作，操作基本介绍可以放在网页上。
1.3.17 故障处理
- 首先将前端主页面引导到说明页面
- 分功能查找定位故障点
- 修复故障
- 重新引导页面
- 通知用户故障修复
1.3.18 算法说明
主要对数据操作的功能均有后端数据库提供操作命令，无需要额外设计的算法。
1.3.19 有关人员的需求
| 有关人员 | 需求内容 |
|---|---|
| 需方 | 需要本项目的建模文档以及可能的开发成果 |
| 用户 | 能够使用基本功能 |
1.3.20 有关培训的需求
| 培训对象 | 内容 |
|---|---|
| 用户 | 在主页面简单介绍基本的使用方法即可 |
| 平台后端运维人员 | 介绍基本的后端管理方法 |
| 信息管理员 | 需要培训相关维护平台言论问题，防止出现不当言论 |
1.3.21 有关后勤的需求
- 对后端数据库的日常维护
- 对平台信息的管理与审核
- 平台运行的日常维护，如前端优化等
- 适当宣传，如每到期末考试结束以及选课时加强本平台的宣传工作
1.3.22 其他需求
暂无相关设计。
1.3.23 包装需求
| 名称 | 内容 |
|---|---|
| 宣传 | 需要加大加强本系统的宣传工作，能够让广大BIT在校生知道和使用本系统 |
| 页面美工 | 需要对网页进行美工处理，因为目前本项目开发成员均无较好的美术功底，所以在页面设计方面有所欠缺 |
| 访问 | 需要能够友好、快速的进入系统的主页面 |
1.3.24 需求的优先次序和关键程度
| 需求名称 | 优先级 | 关键程度 |
|---|---|---|
| 评价查询 | 第一优先 | 非常关键 |
| 提问 | 第二优先 | 较为关键 |
| 发表评论 | 第二优先 | 较为关键 |
| 修改、删除提问/评论 | 第三优先 | 关键 |
| 登陆、注册 | 第二优先 | 较为关键 |
1.4 合规性规定
由于本项目还处于开发阶段，同时由于本课程结课以及期末，故本项目冻结，所以对合规性没有设计。
1.5 需求可追踪性
需求变动时需要重新制定基线，以及重新进行1技术分析等相关需求分析活动。同时每次需求变更需要记录。
1.6 尚未解决的问题
- 注册与登陆
- 移动端页面出现部分功能失效
- 前端录入信息自动标签化
1.7 注解
暂无注解需要。
附录
无。
二、数据需求说明
2.1 引言
2.1.1 标识
2.1.2 系统概述
数据库部分主要提供评价信息的录入与查询，这样用户可以为平台贡献评价信息，同时也可以从平台获取数据。
2.1.3 文档概述
本文档主要说明了数据库中的数据结构。
2.2 引用文件
2.3 数据的逻辑描述
数据库中需要存储学院，专业，年级，课程，教师，用户，评价记录。
关于一些数据格式的说明
- 用户的邮箱不能重复。
- 课程中的课程简介可以为空。
用户的用例图分析
管理员的用例图分析
序列图
2.4 数据的采集
数据采集在项目初期主要由我们开发组人员中的信息收集人员收集，在计划中是由用户本身作为评价的数据的贡献者。
2.5 注解
无。
附录
无。