A document review
1. Document Properties
| File |
With brigade APP Requirements Document |
| version |
v1.0.1 |
| author |
Mos |
| purpose |
Clear product details, to provide the needs of developers, building products |
Table 2. Revision History
| Numbering |
version number |
The revised chapter |
Amendment to |
Revision Date |
Revision people |
| BL101 |
v1.0.1 |
Initial revision |
Initial revision |
2019.6.26 |
Mos |
|
|
|
|
|
|
|
3. Product Overview
| industry analysis |
According to the China Tourism Research Institute show: 2018 Chinese tourism market to achieve steady growth, domestic tourism 3.611 billion people, an increase of 10.67%; domestic tourism revenue reached 3.0312 trillion yuan, an increase of 15.40%. |
| Product Positioning |
Internet travel agency specializing in cross-platform |
| feature of product |
[Online] Friends of the trip looking to provide accurate online services to find travel companions [Record] footprint to create user-specific travel city records |
Second, the product description
1. Product functional configuration of FIG.
2. Product information structure diagram
Third, the global description
1. Feature Permissions
Login with real names
|
|
Landed |
No landing |
| Real name |
You can access all the features page |
\ |
| No real names |
Among other functions initiated activities in the field can be used (can participate in activities) |
Can not be used to participate in activities, initiate activities concerned friends, other users are concerned, honors, records and other functions footprint |
2. Description keyboard interaction
Click APP phone number input box, the bottom of the page pop-up numeric keypad.
When you click the other input box, from the bottom of the page pop-up alphanumeric keyboard.
3. anomalies Description
APP reopened after interrupted:
| Return to the desktop / temporary telephone access |
Continue to display the original picture |
| Dirty Shutdown |
Home |
Click on an empty area or no network situation:
| Click on a blank area |
When there is no non-modal popups or the keyboard, click on the blank no response; otherwise hidden pop or keyboard |
| When the user no network |
Open APP no network, pop-up "the current network is unavailable," pop APP use off network, without switching page does not prompt, switch the page request after the timeout ,, pop "Network disconnected" pop |
4. Data Description
| No. |
Module |
Field Name |
type of data |
The maximum length |
Remark |
| 1 |
log in Register |
phone number |
digital |
11 |
|
| 2 |
log in Register |
Verification code |
digital |
4 |
|
| 3 |
User Info |
nickname |
String |
16 |
|
| 4 |
News |
Date / Time |
date |
|
Day of show: hh: mm Other date: YYYY Year MM Month DD Day |
Fourth, functional details
1. Home module
1.1. Page interaction process
1.2. Home
1.2.1. Example illustrates the use
| Home: UC_00101 |
||||||
| EXAMPLES General use |
||||||
| Functional Description |
Home side, the overall style display platform, is the entrance to all modules |
|||||
| Process Description |
Open APP → → Home page guide surface |
|||||
| Pre-conditions |
no |
|||||
| Kisaki置 conditions |
no |
|||||
| 其他说明 |
无 |
|||||
| 界面描述 |
||||||
| UI示意图：首页UI |
||||||
|
|
||||||
| 界面元素 |
||||||
| 编号 |
功能 |
描述 |
交互说明 |
字段 |
必填 |
备注 |
| 001011 |
定位功能 |
页面载入时，获取当前位置 |
点击进入城市选择页 |
1.城市名 |
是 |
1.显示3位超出中间显示… |
| 001012 |
查找好友 |
用户查找好友入口 |
点击进入查找好友页 |
1.查找好友页URL |
是 |
|
| 001013 |
活动轮播图 |
官方推荐活动入口 |
点击进入对应活动详情页 |
1.轮播图片URL |
否 |
1.根据后台配置 2.最多可配置6张 |
| 001014 |
Tab标签列表 |
定位地近期可参加活动 |
1.点击Tab切换对应列表 |
1.城市名 |
是 |
1.列表中数据状态均为进行中 6.当前城市无活动时列表显示活动缺省信息 |
| 001015 |
底部导航 |
进入对应页面 |
点击进入对应页面 |
1.活动页URL |
是 |
|
1.2.2. 埋点数据设计
| 埋点数据说明 |
||||||
| 埋点id |
功能 |
统计维度 |
统计说明 |
统计字段 |
||
| 10101 |
首页页面 |
曝光PV和UV |
统计打开率 |
埋点id |
用户id |
操作时间 |
| 10102 |
查找好友入口 |
点击PV和UV |
了解用户使用该功能的频率 |
埋点id |
用户id |
操作时间 |
| 10103 |
活动banner |
点击PV和UV |
结合10101埋点数据了解活动投放效果 |
埋点id |
用户id |
操作时间 |
| 10104 |
tab切换活动列表 |
点击PV和UV |
了解本地与本地出发活动打开比例 |
埋点id |
用户id |
操作时间 |
1.3. 城市选择
1.3.1. 用例说明
| 首页模块：UC_00102 |
||||||
| 用例概述 |
||||||
| 功能描述 |
城市选择：定位不准确、或者用户希望了解其他城市活动情况时 |
|||||
| 流程描述 |
首页 →点击左上角城市 →进入城市选择页面 →点击城市名 →首页 |
|||||
| 前置条件 |
无 |
|||||
| 后置条件 |
选择后首页城市名称更新；活动列表内容更新为对应城市活动 |
|||||
| 其他说明 |
该城市无活动信息时，活动列表显示缺省信息 |
|||||
| 界面描述 |
||||||
| UI示意图：城市选择UI |
||||||
|
|
||||||
| 界面元素 |
||||||
| 编号 |
功能 |
描述 |
交互说明 |
字段 |
必填 |
备注 |
| 001021 |
当前定位 |
1.显示当前定位城市，且城市名前显示定位标识 2.无法获取位置信息时显示”重新定位” |
1.定位成功：点击进入首页 2.定位失败：点击重新定位,刷新定位信息 |
1.城市名 3.城市类型 |
是 |
1.定位失败的响应时间为3s，3 2.城市类型分为：当前定位城市、热门城市、普通城市三类 |
| 001022 |
热门城市 |
热门城市列表 |
点击进入首页 |
1.城市名 3.城市类型 |
是 |
初期默认：北京、三亚、厦门、丽江、张家界、成都（数据选自途牛） |
| 001023 |
字母排序城市 |
按字母排序的全部国内城市列表 |
点击进入首页 |
1.城市名 3.城市类型 4.首字母 |
是 |
精确到地级市 |
| 001024 |
字母标签列表 |
提供快捷城市选择功能 |
点击字母页面滑动至对应字母的城市列表 |
|
是 |
该字母无城市，则滑动到上一个字母对应城市列表，以此类推 |
| 001025 |
返回 |
返回上级页面 |
点击返回进入首页 |
|
是 |
|
1.3.2. 埋点数据设计
| 埋点数据说明 |
|||||||||
| 埋点id |
功能 |
统计维度 |
统计说明 |
统计字段 |
|||||
| 10201 |
城市选择页面 |
曝光PV和UV |
统计打开率 |
埋点id |
用户id |
操作时间 |
|||
| 10202 |
选择城市 |
点击PV和UV |
1.了解定位功能的准确性和可靠性 |
埋点id |
用户id |
城市id |
城市类型 |
定位状态 |
操作时间 |
1.4. 查找好友
1.4.1. 用例说明
| 首页模块：UC_00103 |
||||||
| 用例概述 |
||||||
| 功能描述 |
通过手机号或昵称对平台用户进行查找 |
|||||
| 流程描述 |
首页 →点击右上角加号 →进入查找好友页面 →内容输入 →点击键盘确定 →展示搜索结果 |
|||||
| 前置条件 |
关注用户需要登陆 |
|||||
| 后置条件 |
点击列表用户进入用户信息页，点击关注关注用户 |
|||||
| 其他说明 |
|
|||||
| 界面描述 |
||||||
| UI示意图：查找好友UI |
||||||
|
|
||||||
| 界面元素 |
||||||
| 编号 |
功能 |
描述 |
交互说明 |
字段 |
必填 |
备注 |
| 001031 |
搜索 |
用户通过手机号或用户昵称进行用户搜索 |
点击搜索框，拉起键盘，输入信息后，点击键盘确定（回车）搜索信息 |
是 |
未输入时搜索结果展示默认缺省信息 提示文案：“手机号/昵称” |
|
| 001032 |
查找结果列表 |
查找到的用户列表 |
1.点击用户信息进入用户信息页 2.点击关注/取消关注切换关注状态，按钮颜色对应改变 |
1.用户头像 2.用户性别 3.用户个性签名 4.用户粉丝数 5.用户关注数 6.用户被关注状态 7.用户id |
是 |
未关注时-关注按钮，文字：“+关注”；颜色：黄色 关注时-关注按钮，文字：“-关注”；颜色：灰色 |
| 001033 |
返回 |
返回上级菜单 |
点击返回，回到首页页面 |
是 |
||
1.4.2. 埋点数据设计
| 埋点数据说明 |
||||
| 埋点id |
功能 |
统计维度 |
统计说明 |
统计字段 |
2. 活动模块
2.1. 页面交互流程
2.2. 活动页
2.2.1. 用例说明
| 活动：UC_00201 |
||||||
| 用例概述 |
||||||
| 功能描述 |
用户查看自己参加和发起的活动入口 |
|||||
| 流程描述 |
首页 →点击底部导航栏-活动 |
|||||
| 前置条件 |
用户登陆 |
|||||
| 后置条件 |
点击列表活动进入活动详情页 |
|||||
| 其他说明 |
无 |
|||||
| 界面描述 |
||||||
| UI示意图：首页UI |
||||||
|
|
||||||
| 界面元素 |
||||||
| 编号 |
功能 |
描述 |
交互说明 |
字段 |
必填 |
备注 |
| 002001 |
活动轮播图 |
官方推荐活动入口 |
点击进入对应活动详情页 |
1.轮播图片URL |
否 |
1.根据后台配置 |
| 002002 |
Tab标签列表 |
用户发起的或用户报名的活动列表信息 |
1.点击Tab切换对应列表 |
1.城市名 15.活动状态 |
是 |
1.列表中数据状态分为进行中、已结束、已取消 6.用户未登陆显示登陆提示页；用户无活动显示活动缺省页
|
| 002003 |
底部导航 |
进入对应页面 |
点击进入对应页面 |
1.首页URL |
是 |
|
2.2.2. 埋点数据设计
| 埋点数据说明 |
||||||
| 埋点id |
功能 |
统计维度 |
统计说明 |
统计字段 |
||
| 10201 |
活动页面 |
曝光PV和UV |
统计该页面的使用率，为后续整体产品架构优化提供依据 |
埋点id |
用户id |
操作时间 |
| 10202 |
活动banner |
点击PV和UV |
结合10201埋点数据了解活动投放效果 |
埋点id |
用户id |
操作时间 |
3. 发起活动模块
3.1. 页面交互流程
3.2. 发起活动页
3.2.1. 用例说明
| 发起活动：UC_00301 |
||||||
| 用例概述 |
||||||
| 功能描述 |
用户发起寻找旅行伴侣活动的入口 |
|||||
| 流程描述 |
首页 →点击底部导航栏-加号（发起活动）→填写活动信息 →提交活动 →活动页 |
|||||
| 前置条件 |
用户登陆、实名认证 |
|||||
| 后置条件 |
点击提交回到活动页面、点击选择主页图片选择完成后在该位置显示图片 |
|||||
| 其他说明 |
无 |
|||||
| 界面描述 |
||||||
| UI示意图：首页UI |
||||||
|
|
||||||
| 界面元素 |
||||||
| 编号 |
功能 |
描述 |
交互说明 |
字段 |
必填 |
备注 |
| 003001 |
活动简介内容填写 |
填写要发起的活动的基本信息 |
1.地点选择进入城市选择页，选择后返回发起活动页 2.日期选择进入日期选择页，选择后返回活动发起页 3.点击住宿方式、期望性别、期望人数、预计每日花销下方出现对应的选择栏进行选择 4.图片选择进入选择 图片页，选择后返回活动发起页，将选择的图片渲染至“选择图片位置”，底部文字变更为“首页图片” |
4.结束日期 10.发起人id
|
是 |
1.出发地、目的地：选择前默认出发地为当前定位位置，定位失败默认为当前热门top1城市；目的地默认为当前热门top1城市 2.所有信息选择后将选择的信息显示在对应位置 3.首页图片选择后可通过点击图片重新选择 |
| 003002 |
活动内容填写 |
自定义填写活动内容 |
点击活动内容输入位置获取焦点拉起键盘 |
1.活动内容 |
否 |
最大长度800字符 |
| 003003 |
活动提交 |
对已完成的活动进行提交 |
提交活动信息 |
|
|
1.点击提交检查页面必填元素是否填写完整，不完整弹框提醒，留在当前页面 2.检查日是否合适，不合适弹窗提醒，留在当前页面 |
3.2.2. 埋点数据设计
| 埋点数据说明 |
||||||
| 埋点id |
功能 |
统计维度 |
统计说明 |
统计字段 |
||
| 10301 |
发起活动页面 |
曝光PV和UV |
统计打开率 |
埋点id |
用户id |
操作时间 |
4. 消息模块
4.1. 页面交互流程
4.2. 消息页
4.2.1. 用例说明
| 消息：UC_00401 |
||||||
| 用例概述 |
||||||
| 功能描述 |
所有消息信息的统一入口 |
|||||
| 流程描述 |
首页 →点击底部导航栏-消息 →进入消息页 |
|||||
| 前置条件 |
群消息、对话消息需要登陆 |
|||||
| 后置条件 |
点击对应消息图标进入对应页面、点击对话框进入对话详情 |
|||||
| 其他说明 |
无 |
|||||
| 界面描述 |
||||||
| UI示意图：首页UI |
||||||
|
|
||||||
| 界面元素 |
||||||
| 编号 |
功能 |
描述 |
交互说明 |
字段 |
必填 |
备注 |
| 004001 |
消息分类列表 |
对除对话外消息进行分类 |
点击图标进入对应页面 |
1.消息大类型 3.消息页面URL |
是 |
1.系统消息小类型： 101.系统通知：系统公告、升级提示； 102.系统提醒：新增粉丝、荣誉、足迹等提醒消息 2.活动消息小类型： 201.官方活动通知 202.普通活动提醒：参加活动结果、取消活动结果、发起活动结果、审批信息、审批结果等等与活动状态变更相关的提醒 |
| 004002 |
对话列表 |
个人对话消息列表 |
点击进入对应对话详情页 |
1.好友名称 2.好友头像URL 3.最新消息内容 4.最新消息时间 |
是 |
|
4.2.2. 埋点数据设计
| 埋点数据说明 |
|||||||
| 埋点id |
功能 |
统计维度 |
统计说明 |
统计字段 |
|||
| 10401 |
消息页面 |
曝光PV和UV |
统计打开率 |
埋点id |
用户id |
操作时间 |
|
| 10402 |
点击系统消息 |
点击PV |
了解用户使用该功能的频率，为后续优化提供支持 |
埋点id |
用户id |
最新消息时间 |
操作时间 |
| 10403 |
点击活动消息 |
点击PV |
了解用户使用该功能的频率，为后续优化提供支持 |
埋点id |
用户id |
最新消息时间 |
操作时间 |
| 10404 |
点击群消息 |
点击PV |
了解用户使用该功能的频率，为后续优化提供支持 |
埋点id |
用户id |
最新消息时间 |
操作时间 |
5. 我的模块
5.1. 页面交互流程
5.2. 我的页
5.2.1. 用例说明
| 首页：UC_00501 |
||||||
| 用例概述 |
||||||
| 功能描述 |
用户信息入口 |
|||||
| 流程描述 |
首页 →点击底部导航栏-我的 →进入我的页 |
|||||
| 前置条件 |
用户登陆 |
|||||
| 后置条件 |
点击对应描述进入对应页面 |
|||||
| 其他说明 |
未登录用户进入该页面重定向至登录/注册页 |
|||||
| 界面描述 |
||||||
| UI示意图：首页UI |
||||||
|
|
||||||
| 界面元素 |
||||||
| 编号 |
功能 |
描述 |
交互说明 |
字段 |
必填 |
备注 |
| 005001 |
用户信息 |
用户基本信息 |
点击进入用户信息页 |
1.用户头像URL 3.用户个性签名 4.用户信息页URL |
是 |
1.用户头像未上传时显示默认头像 2.用户昵称最大显示10个字符 超出显示9个字符+“…” 如：我的世界上最好的蔡徐坤，显示：我的世界上最好的蔡… 3.个性签名最大显示16个字符，超出显示15个字符+“…” |
| 005002 |
用户关键信息分类列表 |
用户粉丝、关注、荣誉等页面入口 |
点击进入对应页面 |
1.类型 2.数量 3.类型描述 4.页面URL |
是 |
|
| 005003 |
用户足迹 |
用户足迹页面入口 |
点击进入足迹页面 |
1.城市名称 2.城市图片URL 3.足迹页面URL |
是 |
城市按用户旅行时间倒序堆叠排列 |
5.2.2. 埋点数据设计
| 埋点数据说明 |
|||||||
| 埋点id |
功能 |
统计维度 |
统计说明 |
统计字段 |
|||
| 10501 |
我的页面 |
曝光PV和UV |
统计打开率 |
埋点id |
用户id |
操作时间 |
|
| 10502 |
点击关注 |
点击PV和UV |
了解用户使用该功能的频率，为后续优化提供支持 |
埋点id |
用户id |
定位状态 |
操作时间 |
| 10503 |
点击粉丝 |
点击PV和UV |
了解用户使用该功能的频率，为后续优化提供支持 |
埋点id |
用户id |
操作时间 |
|
| 10504 |
点击荣誉 |
点击PV和UV |
了解用户使用该功能的频率，为后续优化提供支持 |
埋点id |
用户id |
操作时间 |
|
| 10505 |
点击我的足迹 |
点击PV和UV |
了解用户使用该功能的频率，为后续优化提供支持 |
埋点id |
用户id |
操作时间 |
|
五、 非功能性需求
1. 性能需求
APP 启动时间不超过 5 秒（现在启动时间为 3 秒）。
APP 内操作的响应时间不超过 3 秒，在网络连接超时/弱网情况下，需给出相应提示并可重新加载。（ APP 内播放视频时，无网络情况下没有给出提示，加载图在一直转动，浪费用户时间。）
程序闲时没有异常的 CPU 占用，忙时没有异常的峰值占用。
前端实现图片懒加载，节约用户流量，保障页面加载速度。
2. 可用性需求
容错性：必要的引导和提示文字，应该突出能够让用户看到；当操作结果不可逆的时候，需要有模态弹窗询问用户让其知道操作的后果并做出选择；通知用户、不会影响用户操作、用户可以不予回应的通知，用非模态弹窗来实现。
状态可见：让用户了解自己处于何种状态。
环境贴切：使用用户熟悉的界面范式和概念。
用户可控：页面返回按钮应明显，位置应统一，防止用户因误触进入页面而无法返回。
一致性：结构/色彩/文字/操作/反馈一致性。