碧瑶答疑网-软件需求规格说明书

Posted 2020-11-02 fangzehui

GitHub链接：https://github.com/sjzsjzsjz/analyse

1. 引言

1.1 目的

       本文档首先给出项目的整体结构和功能结构概貌，试图从总体架构上给出整个系统的轮廓。同时对功能需求、性能需求进行了详细的描述。便于用户、开发人员进行理解和交流，反映出用户问题的结构，可以作为软件开发工作的基础和依据以及确认测试和验收的依据。

    本文档面向多种读者对象：

（1）项目经理：项目经理可以根据该文档了解预期产品的功能，并据此进行系统设计、项目管理。

（2）设计员：对需求进行分析，并设计出系统，包括数据库的设计。

（3）程序员：了解系统功能，编写《用户手册》。

（4）测试员：根据本文档编写测试用例，并对软件产品进行功能性测试和非功能性测试。

（5）用户：了解预期产品的功能和性能，并与分析人员一起对整个需求进行讨论和协商。

      在阅读本文档时，首先要了解产品的功能概貌，然后可以根据自身的需要对每一功能进行适当的了解。

1.2 背景

      本次待开发的网站为碧瑶答疑网。用户通过使用该网站在移动终端完成资讯浏览、交流、发帖及回帖等操作，以实现答疑解惑的目的。

1.3 定义

序号	缩写	定义
1.	Web	网站，Website的缩写，一般指用于展示特定内容的相关网页的合集。
2.	Windows	Microsoft Windows，是一种基于图形化模式GUI，主要使用于电脑的操作系统，由美国微软公司研发。

1.4参考文献

[1] GB-T8567-2006，《计算机软件文档编制规范》[S].

[2] 邹欣著.构建之法 现代软件工程.第三版.人民邮电出版社,2015

 

2. 项目概述

2.1 产品描述

       通过开发基于Windows平台的网站完成资源整合及用户交流等操作，以实现为用户答疑解惑的目的。

2.2 产品功能

      人们在学习和工作上经常会遇到各种各样的问题，希望与业内人士进行交流，互相取经，但很难找到一个合适的平台，或者需要查找一些相关资料，但却因为网上林林总总的资源而感到头晕目眩。因此我们通过此次碧瑶答疑网的开发，解决用户的上述困扰。

     用户场景如下：

     用户A在课后学习过程中遇到了难题，身边的同学也不懂。于是他上网百度，可是搜索出来的结果要么就不是自己想要的回答，要么就是看不懂答案没有解析。

     碧瑶答疑网的帮助方式：

      网站共有四个模块，包括问题列表、问题发表、讨论区、个人中心。用户A（提问者）在碧瑶答疑网上发帖提问，用户B（答疑者）在浏览问题列表时看到了这条问题贴跟自己的专业有关，于是发起回帖，帮助用户A解决了问题。两人因志同道合便互加好友，进一步展开交流。

2.3 用户特点

     本网站的用户为有信息咨询需要的人，所有人都可能是碧瑶答疑网的用户。

2.4 一般约束

    进行本软件开发工作的约束条件如下：

（1）开发周期短：两个月的开发时间需要开发者合理规划时间，做到多项任务并发。

（2）所采用的方法与技术有限：项目团队成员的技术水平不够成熟，需要在开发中并发学习多种技术和能力。

2.5 假设与依据

   本项目是否能够成功实施，主要取决于以下的条件：

（1）团队成员的积极合作配合，为了项目的开发和实施，对个人时间进行合理规划，同时为团队做出合理牺牲，配合队友完成任务。

（2）课程教师提供完整详细的功能和性能需求资料，以便于团队对其进行分析，从而形成完善的软件需求。

（3）团队掌握先进的能够适用于该项目的技术，这是系统的性能是否优化和项目能否成功的保证。

3. 具体需求

      首先引入类图明确该项目中的角色分类及其角色间的相互联系。

 

3.1 功能需求

1. 注册界面

新用户通过用户名输入，密码输入，再次确认密码，实现账户注册。

 

 

2. 登录界面

用户通过输入用户名和密码，点击登录，登录之后进入碧瑶答疑网的主界面。

 

 

3. 问题列表界面

用户通过点击导航条上面的“问题列表”，就会按时间顺序显示出其他用户发表的问题贴及回帖，问题和答案会以不同的颜色显示。

 

 

4. 发表问题界面

用户通过点击导航条上面的“发表问题”，就会进入发表问题的界面，该界面可以发表自己的问题贴，其中包括图片及视频插入功能，点击发表按钮，消息就会出现在最新的问题列表当中。

 

 

 

5. 讨论区界面

用户通过点击导航条上面的“讨论区”就会进入到学习交流区域，可以和不同的用户互相讨论与交流。

 

 

6. 个人聊天界面

用户点击“个人聊天界面”就进入到了一个简洁的聊天页面，在这里，你可以跟你的好友私聊，别人无法看到，也能在这里实现添加好友、删除好友的功能，然后还有一个注销登陆的功能，注销登陆后就返回到一开始的登录界面。

 

 

3.2 外部接口需求

3.2.1 用户接口

本系统采用C/S架构，即客户/服务器模式，所有界面使用Web风格，用户界面的具体细节在功能需求文档中描述。

3.2.2 硬件接口

    无特殊需求。

3.2.3 软件接口

    无特殊需求。

3.2.4 通信接口

    无特殊需求。

3.3 性能需求

类别	字段		精度
用户类	用户名	UserName	6-18个字符
	密码	Password	6-18个字符
	性别	Name	只有“男”、“女”
	手机号	PhoneNumber	11位数字
	生日	Birthday	不超过32个字符
	所在学校	School	不超过32个字符
	个人说明	Describe	不超过500个字符
	头像	Photo	大小不超过500k
帖子	标题	Title	不超过50个字符
	发布者	Question	不超过20个字符
	回答者	Answer	不超过20个字符
	图片	Photo	大小不超过900k
	时间	Time	不超过500个字符
管理员	管理员名	Admin	6-18个字符
	密码	Password	6-18个字符
系统类	用户表单	Table
	帖子列表	List

1. 按照规定的数据格式输入，否则系统提示错误并要求重新输入。

2. 搜索的时候所有包含关键字的记录保证全部搜索到。

3. 程序响应时间在人的感觉和视觉范围内，长时间无响应应提示用户刷新。

4. 要求数据库有很好的更新能力。

5. 能够适应迭代开发。

3.4 属性

3.4.1 可用性

（1）方便操作，容易理解。尽量从用户角度出发，设计简洁易用的界面。

（2）具有稳定性。系统会更新增加功能，不断修复 bug，使系统更加稳定。

（3）容错能力。系统具有一定的容错和抗干扰能力，在非硬件故障或非通讯故障时，系统能够保证正常运行，并有足够的提示信息帮助用户有效正确地完成任务。

（4）操作完成时有统一规范的提示信息。例如删除操作时，系统可提示警示框“您确认删除记录吗？操作不可恢复！”，用户点击确认后，系统才执行删除操作，删除后可直接返回相关页面。

3.4.2 安全性

（1）故障处理

正常使用时不应出错，若运行时出现不可恢复的系统错误，也必须保证数据库完好。

（2）重要数据加密

对一些重要的数据按一定的算法进行加密，如用户口令、重要参数等。

（3）数据备份

允许用户进行数据的备份和恢复，以弥补数据的破坏和丢失。

（4）记录日志

本系统应该能够记录系统运行时所发生的所有错误，包括本机错误和网络错误。这些错误记录便于查找错误的原因。日志同时记录用户的关键性操作信息。

3.4.3 可维护性

（1）保留系统对应的版本的源代码。

（2）代码一定要有注释，特别是关于 if else，每个条件到底意味这什么，一定要有清晰的描述。

（3）清晰的系统结构和命名规范，界面规范，提示和帮助信息规范，友好的错误提示信息，可以帮助用户自己找原因，自己维护系统。

（4）完善的系统配置管理，在项目开始之后，就需要进行，直到项目结束之后，维护工作

中，仍然需要不断更新系统配置信息。按模块对系统进行配置项的划分，对系统每次维护工

作，都进行记录，留待将来检查。

4. 验收验证标准

4.1 文档验收标准

1. 开题报告

2. 软件需求规格说明书

3. 项目总结报告

4.2 软件验收标准

1. 网站网址

2. 后台管理程序（PC端）

4.3 界面验收标准  

测试功能	测试项	输入/操作	检验点	预期结果	验收情况
登录功能	初始界面		用户名、密码为空	登录按键完整
			用户名可以为中文或者英文	用户名的输入框完整
			密码长度最多18位	密码框完整
	登录动作	无信息输入，点击登录	确认功能、结果显示	登录失败
				警告提示：“请输入用户名和密码”
		仅输入用户名或密码（输入类型正确；无论存在与否）其一，点击登录	确认功能、结果显示	登录失败
				警告提示：“请输入完整登陆信息”
		输入用户名及密码，两者其一错误或都错误（输入类型正确），点击登录	确认功能、结果显示	登录失败
				警告提示：“请输入正确的登陆信息”
选择功能	主界面		主导航为发表问题、问题列表、讨论区、个人聊天	主导航四个功能的按键
	选择动作	点击问题列表	跳转功能	跳转至问题列表界面
		点击发表问题	跳转功能	跳转至发表问题界面
		点击讨论区	跳转功能	跳转至讨论区界面
		点击个人聊天	跳转功能	跳转至个人聊天界面
问题列表模块	初始界面	点击相应问题	跳转功能	跳转到问题详细描述界面
发表问题模块	发表问题界面		跳转功能	发表完问题跳回到主界面
讨论区模块	讨论区界面			发表个人想法在当前页面显示
个人聊天模块	选择动作	点击其中一个好友		显示相应的对话框
		点击注销账号	跳转功能	跳转到登录界面
		点击添加好友	跳转功能	跳转到好友添加界面
		点击删除好友	确认功能、结果显示	删除好友成功
		修改个人资料	跳转功能	跳转到修改界面，编辑个人资料并保存