团队作业2——《需求规格说明书》
一、需求规格说明书
文档链接：https://www.yuque.com/writingcode6/uk0fw1/ic3py4
《社区管理系统》需求规格说明书
当前版本：V0.1.0
组员：方晓莹，方子茵，黄芯悦，舒雯钰，利国铭，许嘉威
一、前言
1.1 目的
《社区管理系统》需求规格说明书主要用于开发人员针对系统的功能需求进行开发。
1.2 范围
以小区/社区为单位，社区管理人员和社区居住人员为面向对象。
1.3 说明
二、项目概述
2.1 项目背景
随着经济的发展，社区渐渐走入我们的生活中，人们不但对社区本身的美观，质量要求越来越高，同时对社区的管理和服务也有很高的需求。为了使社区有更好的服务，我们创建了这个社区管理系统。
2.2 项目定位
本系统旨在完成三大特性，如下：
1. 真实性：针对物业和住户双方，本系统可以有效提高信息准确度和可靠性，同时建立高效的信息传输和服务平台；
2. 可用性：本系统作为一个线上平台，可以达到减少人力资源的使用和降低管理费用的目的，基于互联网的交流，还能有效提高信息处理速度和利用率；
3. 有价值性：本社区管理系统旨在以现代技术创新和科学管理为宗旨，运用现代化管理手段，实现多方面、多角度缓解物业管理人员的工作压力，真正做到便利用户生活，使物业管理走向规范化进程，给予住户更优质的服务、更贴心的安排。
2.3 项目描述
本系统涵盖了社区内管理的许多功能，包括住户模块的个人资料、车位查询、物业查询、社区通知等，以及物业模块的户主信息管理、人事信息管理、社区资源管理等。
2.4 用户特点
本系统主要面向两类用户，一类是物业管理员，使用本系统管理用户信息、进行人事管理和资源管理等，实现和用户的实时交流、实时反馈；另一类是用户，使用本系统查看物业工作情况、社区临时通知、社区文化活动等，能获取物业的最新消息。
2.5 项目用户量
社区管理人员和社区居住人员共1000-3000名。
三、项目架构图
3.1 需求功能架构
3.2 页面模块架构
四、功能需求
4.1 项目角色
管理员
管理员是物业人员，主要负责社区管理系统的信息管理。
用户
用户是社区住户，主要通过社区管理系统查询社区信息。
4.2 需求分析
4.2.1 登录
一、管理员，用户
1. 在系统中登录账号
|
简要描述 |
有账号的用户可以在系统中登录账号，进入主页面 |
|
主事件流 |
1. 进入登录页 2. 输入登录所需用户名和密码 3. 跳转到主页面 |
|
其他事件流 |
|
|
异常情况 |
1.用户名或密码格式错误，弹出提示 2.用户名和密码不符，弹出提示 |
|
特殊情况 |
1.无法登录，因为系统中没有录入相关信息 |
4.2.2 个人中心
一、管理员，用户
1.查看个人信息
|
简要描述 |
管理员和用户可通过个人中心查看个人信息 |
|
主事件流 |
1. 点击个人中心 2. 查看个人信息 |
|
其他事件流 |
1.点击导航栏，跳转到不同页面 2.点击退出登录，跳转到登录页 3.点击刷新，刷新个人信息页面 |
|
异常情况 |
1. 个人信息为空 |
|
特殊情况 |
1.部分个人信息由于不完善而不显示 |
2.修改个人信息
|
简要描述 |
管理员和用户可通过个人中心修改个人信息 |
|
主事件流 |
1. 点击修改 2. 编辑个人资料 3. 点击保存 4. 跳转至修改后的个人中心 |
|
其他事件流 |
1. 点击返回，跳转至个人中心的页面 |
|
异常情况 |
1.修改失败，弹出提示 |
|
特殊情况 |
1.部分信息不可修改 |
3.修改密码
|
简要描述 |
管理员和用户可通过修改密码修改 |
|
主事件流 |
1. 点击修改 2. 编辑旧密码和新密码 3. 点击保存 4. 跳转至修改后的个人中心 |
|
其他事件流 |
1. 点击返回，跳转至修改密码的页面 |
|
异常情况 |
1.旧密码不符合，弹出提示 2.两次新密码输入不一样，弹出提示 3.修改失败，弹出提示 |
|
特殊情况 |
|
4.2.3 审核用户
一、管理员
1.增加用户
|
简要描述 |
管理员在住户相关页面中新增用户 |
|
主事件流 |
1. 点击住户相关页面中的增加用户 2. 输入用户信息 3. 点击完成 4. 跳转至住户相关的页面 |
|
其他事件流 |
1. 点击返回，跳转至住户相关的页面 |
|
异常情况 |
1.住户的必填信息不完善，弹出提示 2.新增失败，弹出提示 |
|
特殊情况 |
1.部分信息可不填 |
2.删除用户
|
简要描述 |
管理员在住户相关页面中删除用户 |
|
主事件流 |
1. 点击住户相关页面中的删除 2. 点击删除 3. 跳转至住户相关的页面 |
|
其他事件流 |
1. 点击返回，跳转至审核用户的页面 2. 点击删除时弹出是否确定删除的弹框 |
|
异常情况 |
1.删除失败，弹出提示 |
|
特殊情况 |
|
3.查看用户
|
简要描述 |
管理员在住户相关页面中查询用户详细资料 |
|
主事件流 |
1. 点击住户相关页面中的查看详情 2. 查看住户的详细资料 3.点击返回 4. 跳转至住户相关的页面 |
|
其他事件流 |
|
|
异常情况 |
|
|
特殊情况 |
1.住户信息加载有误 |
4.查询用户
|
简要描述 |
管理员在住户相关页面中查询用户 |
|
主事件流 |
1. 在住户相关页面的搜索框输入相关信息 2. 点击搜索 3.出现某用户的列表 |
|
其他事件流 |
|
|
异常情况 |
|
|
特殊情况 |
1.无此用户，查询为空 |
4.2.4 车位查询
一、管理员，用户
1.查看车辆资料
|
简要描述 |
管理员和用户查询车辆的具体信息 |
|
主事件流 |
1. 点击车位管理中的车辆资料 2. 点击查看 3. 弹出车辆信息的弹框 |
|
其他事件流 |
1. 点击返回，跳转至车位管理的页面 |
|
异常情况 |
1.因部分用户车辆信息未填导致无法查看 |
|
特殊情况 |
2.查看车位资料
|
简要描述 |
管理员和用户查询车位的具体信息 |
|
主事件流 |
1. 点击车位管理中的车位资料 2. 点击查看 3. 跳转至车位管理页面 |
|
其他事件流 |
1. 点击返回，跳转至车位管理的页面 |
|
异常情况 |
1.因部分车位未录入而无法查看 |
|
特殊情况 |
3.查询车位资料
|
简要描述 |
管理员和用户查询车位 |
|
主事件流 |
1. 在搜索框中输入车位信息 2. 点击搜索 3. 出现车位列表 |
|
其他事件流 |
1. 点击返回，跳转至车位管理的页面 |
|
异常情况 |
1.因部分车位未录入而无法查看 |
|
特殊情况 |
二、管理员
1.增加车辆资料
|
简要描述 |
管理员添加车辆资料 |
|
主事件流 |
1. 点击新增车辆信息 2. 输入车辆信息 3. 点击确定 4. 跳转至车位管理的页面 |
|
其他事件流 |
1.点击返回，跳转至车位管理的页面 |
|
异常情况 |
1.车辆必要资料未填/格式有误弹出提示 |
|
特殊情况 |
1.部分资料可不填 |
2.修改车辆资料
|
简要描述 |
管理员修改车辆信息 |
|
主事件流 |
1. 点击修改 2. 修改车辆资料 3. 点击完成 4. 跳转至车位管理的页面 |
|
其他事件流 |
1.点击返回，跳转至车位管理的页面 |
|
异常情况 |
1.修改格式错误发出提示 |
|
特殊情况 |
3.删除车辆资料
|
简要描述 |
管理员删除车辆信息 |
|
主事件流 |
1. 点击删除 2. 点击确定 |
|
其他事件流 |
1. 点击返回，跳转至车位管理的页面 2. 点击删除时弹出是否确定删除的页面 |
|
异常情况 |
1.车辆资料无法删除 |
|
特殊情况 |
4.增加车位资料
|
简要描述 |
管理员增加车位信息 |
|
主事件流 |
1. 点击增加车位信息 2. 输入车位信息 3. 点击确定 4. 跳转至车位管理的页面 |
|
其他事件流 |
1.点击返回，跳转至车位管理的页面 |
|
异常情况 |
1.车位必要资料未填/格式有误弹出提示 |
|
特殊情况 |
1.部分资料可不填 |
5.修改车位资料
|
简要描述 |
管理员修改车位信息 |
|
主事件流 |
1. 点击修改 2. 修改车位资料 3. 点击完成 4. 跳转至车位管理的页面 |
|
其他事件流 |
1.点击返回，跳转至车位管理的页面 |
|
异常情况 |
1.修改格式错误发出提示 |
|
特殊情况 |
6.删除车位资料
|
简要描述 |
管理员删除车位信息 |
|
主事件流 |
1. 点击删除 2. 点击确定 |
|
其他事件流 |
1. 点击返回，跳转至车位管理的页面 2. 点击删除时弹出是否确定删除的页面 |
|
异常情况 |
1.车位资料无法删除 |
|
特殊情况 |
7.查询车辆资料
|
简要描述 |
管理员和用户查询车辆 |
|
主事件流 |
1. 在搜索框中输入车辆信息 2. 点击搜索 3. 出现车辆列表 |
|
其他事件流 |
1. 点击返回，跳转至车位管理的页面 |
|
异常情况 |
1.因部分车辆未录入而无法查看 |
|
特殊情况 |
4.2.5 物业查询
一、管理员，用户
1.查看物业信息
|
简要描述 |
管理员和用户可通过查询查看物业信息 |
|
主事件流 |
1. 点击物业信息 2. 查看物业信息 |
|
其他事件流 |
|
|
异常情况 |
1.因部分物业信息未填导致无法查看 |
|
特殊情况 |
2.查看人员（清洁/巡查/值班）信息
|
简要描述 |
管理员和用户可通过查询查看人员信息 |
|
主事件流 |
1. 点击人员信息 2. 查看人员信息 |
|
其他事件流 |
|
|
异常情况 |
1.因部分人员信息未填导致无法查看 |
|
特殊情况 |
3.查看报修流程
|
简要描述 |
管理员和用户可通过查询查看报修流程 |
|
主事件流 |
1. 点击物业报修 2. 打开报修流程 3.查看报修流程 |
|
其他事件流 |
1. 点击返回，跳转至物业报修的页面 |
|
异常情况 |
1.因报修信息未填导致查看为空 |
|
特殊情况 |
4.新增报修单
|
简要描述 |
管理员和用户可通过物业查询新增报修单 |
|
主事件流 |
1. 点击物业报修 2. 点击新增报修单 3. 输入报修单信息 4. 点击确定 5. 跳转至物业报修页面 |
|
其他事件流 |
1. 点击返回，跳转至物业报修的页面 |
|
异常情况 |
1．输入部分信息格式有误弹出提示 |
|
特殊情况 |
5.删除报修单
|
简要描述 |
管理员和用户删除报修单 |
|
主事件流 |
1. 点击物业报修 2. 点击删除报修单 3. 点击删除 4. 点击确定 5. 跳转至物业报修的页面 |
|
其他事件流 |
1. 点击返回，跳转至物业报修的页面 2. 点击删除时弹出是否删除确定删除的页面 |
|
异常情况 |
1.报修单删除异常 |
|
特殊情况 |
6.查看报修单
|
简要描述 |
管理员和用户查看报修单 |
|
主事件流 |
1. 点击物业报修 2. 点击查看，查看报修单 3. 点击返回 4. 跳转至物业报修的页面 |
|
其他事件流 |
1．点击返回，跳转至物业报修的页面 |
|
异常情况 |
1.报修单查看异常 |
|
特殊情况 |
7.修改报修单
|
简要描述 |
管理员和用户修改报修单 |
|
主事件流 |
1. 点击物业报修 2. 选择修改的报修单 3. 修改报修单 4. 点击完成 5. 跳转至物业报修页 |
|
其他事件流 |
1.点击返回，跳转至物业报修的页面 |
|
异常情况 |
1.修改格式错误发出提示 |
|
特殊情况 |
二、管理员
1.修改物业信息
|
简要描述 |
管理员修改物业的相关信息 |
|
主事件流 |
1. 点击修改物业信息 2. 修改物业信息 3. 点击完成 4. 跳转至物业信息的页面 |
|
其他事件流 |
1.点击返回，跳转至物业信息的页面 |
|
异常情况 |
1.修改格式错误发出提示 |
|
特殊情况 |
2.新增人员（清洁/巡查/值班）信息
|
简要描述 |
管理员添加人员的相关信息 |
|
主事件流 |
1. 点击新增人员信息 2. 输入人员信息 3. 点击确定 4. 跳转至人员管理的页面 |
|
其他事件流 |
1. 点击返回，跳转至人员管理的页面 |
|
异常情况 |
1.人员必要信息未填/格式有误弹出提示 |
|
特殊情况 |
1.部分资料可不填 |
3.删除人员（清洁/巡查/值班）信息
|
简要描述 |
管理员删除人员的相关信息 |
|
主事件流 |
1. 点击删除人员信息 2. 选择删除的人员信息 3. 点击删除 4. 点击确定 |
|
其他事件流 |
1. 点击返回，跳转至人员管理的页面 2. 点击删除时弹出是否确定删除的页面 |
|
异常情况 |
1.车位资料无法删除 |
|
特殊情况 |
4.修改人员（清洁/巡查/值班）信息
|
简要描述 |
管理员修改人员信息 |
|
主事件流 |
1. 点击修改人员信息 2. 修改人员信息 3. 点击完成 4. 跳转至人员管理的页面 |
|
其他事件流 |
1.点击返回，跳转至人员管理的页面 |
|
异常情况 |
1.修改格式错误发出提示 |
|
特殊情况 |
5.新增报修流程
|
简要描述 |
管理员增加报修流程 |
|
主事件流 |
1. 点击新增报修流程 2. 输入新的报修流程和相关信息 3. 点击确定 4. 跳转至物业报修的页面 |
|
其他事件流 |
1. 点击返回，跳转至物业报修的页面 |
|
异常情况 |
1.报修流程新增异常 |
|
特殊情况 |
6.删除报修流程
|
简要描述 |
管理员删除相关的报修流程 |
|
主事件流 |
1. 点击删除报修流程 2. 选择删除的报修流程 3. 点击删除 4. 点击确定 |
|
其他事件流 |
1．点击返回，跳转至物业报修的页面 2．点击删除时弹出是否确定删除的页面 |
|
异常情况 |
1.报修流程删除异常 |
|
特殊情况 |
7.修改报修流程
|
简要描述 |
管理员修改报修流程 |
|
主事件流 |
1. 点击修改报修流程 2. 修改报修流程 3. 点击完成 4. 跳转至物业报修的页面 |
|
其他事件流 |
1. 点击返回，跳转至物业报修的页面 |
|
异常情况 |
1.修改错误发出提示 |
|
特殊情况 |
4.2.6 社区相关
一、管理员，用户
1.查看社区通知
|
简要描述 |
管理员和用户查看社区的相关通知 |
|
主事件流 |
1. 点击社区相关 2. 点击社区通知 3. 点击退出 4. 跳转至社区相关的页面 |
|
其他事件流 |
1. 点击返回，跳转至社区相关的页面 |
|
异常情况 |
1.因未发布社区通知无法查看 |
|
特殊情况 |
2.查看社区活动
|
简要描述 |
管理员和用户查看社区的相关活动 |
|
主事件流 |
1. 点击社区相关 2. 点击社区活动 3. 点击退出 4. 跳转至社区相关的页面 |
|
其他事件流 |
1. 点击返回，跳转至社区相关的页面 |
|
异常情况 |
1.因未发布社区活动无法查看 |
|
特殊情况 |
二、管理员
1.新增社区通知
|
简要描述 |
管理员新增社区通知 |
|
主事件流 |
1.点击社区相关 2.点击新增社区通知 3.输入社区通知 4.点击确定 5.跳转至社区相关的页面 |
|
其他事件流 |
1.点击返回，跳转至社区相关的页面 |
|
异常情况 |
1.社区通知增加有误 |
|
特殊情况 |
2.删除社区通知
|
简要描述 |
管理员删除相关的社区通知 |
|
主事件流 |
1. 点击社区相关 2. 点击删除社区通知 3. 选择删除的社区通知 4. 点击删除 5. 点击确定 |
|
其他事件流 |
1. 点击返回，跳转至社区相关的页面 2. 点击删除时弹出是否确定删除的页面 |
|
异常情况 |
1.社区通知无法删除 |
|
特殊情况 |
3.修改社区通知
|
简要描述 |
管理员修改社区的相关通知 |
|
主事件流 |
1. 点击社区相关 2. 点击修改的社区通知 3. 修改社区通知 4. 点击完成 5. 跳转至社区相关的页面 |
|
其他事件流 |
1. 点击返回，跳转至社区相关的页面 |
|
异常情况 |
1.社区通知修改异常 |
|
特殊情况 |
4.新增社区活动
|
简要描述 |
管理员新增社区的相关活动 |
|
主事件流 |
1.点击社区相关 2.点击新增社区活动 3.输入社区活动 4.点击确定 5.跳转至社区相关的页面 |
|
其他事件流 |
1．点击返回，跳转至社区相关的页面 |
|
异常情况 |
1.社区活动增加异常 |
|
特殊情况 |
5.删除社区活动
|
简要描述 |
管理员删除相关的社区活动 |
|
主事件流 |
1. 点击社区相关 2. 点击删除社区活动 3. 选择删除的社区活动 4. 点击删除 5. 点击确定 |
|
其他事件流 |
1．点击返回，跳转至社区相关的页面 |
|
异常情况 |
1.社区活动无法删除 |
|
特殊情况 |
6.修改社区活动
|
简要描述 |
管理员修改相关的社区活动 |
|
主事件流 |
1．点击社区相关 2．点击修改社区活动 3．修改社区活动 4．点击完成 5．跳转至社区相关的页面 |
|
其他事件流 |
1. 点击返回，跳转至社区相关的页面 |
|
异常情况 |
1．社区活动修改异常 |
|
特殊情况 |
4.2.7 投诉反馈
一、管理员，用户
1.新增投诉反馈
|
简要描述 |
管理员和用户增加详细的投诉反馈 |
|
主事件流 |
1．点击投诉反馈 2．点击新增投诉反馈、 3．输入投诉反馈相关信息 4．点击确定 5．跳转至投诉反馈的页面 |
|
其他事件流 |
1. 点击返回，跳转至投诉反馈的页面 |
|
异常情况 |
1.投诉反馈增加异常 |
|
特殊情况 |
2.查看投诉反馈
|
简要描述 |
管理员和用户查看相关的投诉反馈 |
|
主事件流 |
1. 点击投诉反馈 2. 点击查看投诉反馈 3. 点击退出 4. 跳转至投诉反馈的页面 |
|
其他事件流 |
1. 点击返回，跳转至投诉反馈的页面 |
|
异常情况 |
1.投诉反馈查看异常 |
|
特殊情况 |
3.修改投诉反馈
|
简要描述 |
管理员和用户修改相关的投诉反馈 |
|
主事件流 |
1. 点击投诉反馈 2. 点击修改投诉反馈 3. 修改投诉反馈 4. 点击完成 5. 跳转至投诉反馈的页面 |
|
其他事件流 |
1. 点击返回，跳转至投诉反馈的页面 |
|
异常情况 |
1.投诉反馈修改异常 |
|
特殊情况 |
二、管理员
1.删除投诉反馈
|
简要描述 |
管理员删除相关的投诉反馈 |
|
主事件流 |
1. 点击删除投诉反馈 2. 选择删除的投诉反馈 3. 点击删除 4. 跳转至删除投诉反馈的页面 |
|
其他事件流 |
1. 点击返回，跳转至删除投诉反馈的页面 |
|
异常情况 |
1.投诉反馈删除异常 |
|
特殊情况 |
（以上需求将根据项目进度有部分增删改）
4.3 原型设计
文档链接：https://www.yuque.com/writingcode6/uk0fw1/suytri
https://www.yuque.com/writingcode6/uk0fw1/ebygih
五、非功能性需求
5.1 性能需求
- 前端内容体验流畅悦目
- 用户在使用过程中，后台信息处理稳定且快速
5.2 系统需求
- 兼容Chrome、Firefox、IE9+的浏览器
六、技术需求
- Vue4.0框架+Element-UI组件库开发
- cs架构
- restful风格开发
- 实现前后端分离
七、附录
代码规范：https://www.yuque.com/writingcode6/uk0fw1/wwvwdv
二、团队项目issues
本次团队项目采用了github的团队仓库，于是选择在github的Projects里添加issues来安排任务。
github团队仓库：https://github.com/WritingCode6
github的团队项目issues：https://github.com/orgs/WritingCode6/projects/1
添加任务计划
前端和后台分别将项目模块化，再将每个模块的内容布置为一个issues，下发到每个成员。
issues截图
整个项目分工如下
前端分工如下
后台分工如下
时间安排表（校正）
|
第 8 周 |
1.团队组队、团队博客 |
|
|
2.团队介绍、成员展示、角色分配、选题确定 |
|
|
3.制定团队计划安排，团队贡献分的规定 |
|
第9周 |
1.需求规格说明书 |
|
|
2. 架构设计，原型设计，原型改进（给目标用户展现原型，并进一步理解需求），团队成员估计各自任务所需时间 |
|
|
3.编码规范完成、平台环境搭建完成、初步架构搭建、测试计划 |
|
|
4.队员估计任务难度并学习必要的技术 |
|
第9、10、11、12周 |
1. 团队项目Alpha任务分配计划，每日代码提交，保持每天的开发进度 |
|
|
2. 测试人员测试，并收集用户反馈+测试计划改进 |
|
第13周 |
1. 团队Alpha阶段个人总结 |
|
|
2. 团队项目Alpha博客：发布说明、测试报告、展示博客、项目管理 |
|
第14周 |
1. 团队项目Alpha博客：事后分析 |
三、团队情况
团队分工+完成情况+个人感想
方晓莹——前端开发、测试
完成情况：开始做前端的静态页面，每天都保持开发进度
个人感想：针对前端中经常出现的内容学会了总结和记忆，能做到反复调用已有的知识来完成正在做的内容
方子茵——后台开发、测试
完成情况：数据库表格已完成，接口开发尚未开始
个人感想：很多基本不会，这周没什么贡献，感谢队友。已迈出第一步，克服了畏难情绪，其他正在探索中
利国铭——PM、开发
完成情况：需求说明书大致完成
个人感想：尚在学习很多知识，针对很多新内容和操作正在探索中，衷心感谢队友的支持。
黄芯悦——前端开发、测试
完成情况：初步完成前端部分静态页面
个人感想：在完成页面的过程中巩固了知识，继续加油
舒雯钰——UI设计、测试
完成情况：原型设计大致完成
个人感想：没有UI设计经验的我从0开始，刚开始有些无从下手，在掌握工具的基本使用方法后，慢慢有了方向。
许嘉威——后台开发、设计
完成情况：完成数据库设计和创建，完成接口文档，完成项目环境搭建
个人感想：使用GitHub团队的project和issue以及语雀对文档和任务进行管理，对软工的流程更加熟悉了点。
