视频业务技术文档编写计划
一、背景和目的
- 知识沉淀：帮助团队成员沉淀知识，记录和分享技术或产品的信息，避免重复工作和知识流失。
- 提高效率：提高团队内部的工作效率，通过提供详细的指导和说明，可以帮助团队成员更快地完成任务。
- 保障质量：提高团队内部的产品或项目质量，通过详细的说明和说明，可以帮助团队成员避免错误和问题。
- 促进协作：促进团队内部的协作，通过记录和分享技术或产品的信息，可以帮助团队成员共享知识并保持一致性。
- 提高团队素质：提高团队成员的素质和能力，通过编写和阅读技术文档，可以帮助团队成员不断学习和提高自己的技能。
二、目标
- 针对视频业务，文档分为四个部分：服务端接口文档、Android开发文档、iOS开发文档、Web开发文档
- 接口文档实现要求：单个接口定义编号和名称，明确适用场景或功能和请求方式，列出入参和出参以及类型，是否必填和默认值，公共错误码、业务错误码和对应含义
- 平台开发文档要求：以业务模块为单元，分别拆分出多个独立的子功能或技术点，以此作为开发文档目录大纲，其中内容大纲要求推荐格式：
-
- 功能概述：介绍该功能需求以及业务流程并罗列要实现的各个子功能或技术点作为最终目标清单
-
- 准备条件：明确实现的前置条件
-
- 技术方案：根据整体业务和功能需求，给出实现原理或解决方案，可以图文多种方式展现
-
- 功能实现：分别对各个子功能业务逻辑进行罗列，并给出实现方案，根据实际情况来决定是否提供代码片段（可多种实现）
-
- 常见问题：罗列可能遇到的问题并给出原因、排查方案或解决方案
-
- 参考引用：罗列文中引用和参考的库，技术文档和三方SDK文档
-
三、文档流程
- 内部撰写
- 评审修改
- 脱敏
- 对外发布
四、视频业务文档目录大纲
接口对接
- 请求和响应参数结构
- 请求和响应参数加解密
- 接口混淆
账号相关
- 游客登录/注册
- 账号登出
- 账号注销
- IM初始化以及注册监听，登录与登出
- Adjust事件上报
- 用户归因（Adjust）
- 三方登录/注册
- Google登录/注册
- Apple登录/注册
- Facebook登录/注册
- 账号绑定
视频通话
- 视频通话
- 前置条件
- 呼叫
- 取消
- 接听
- 拒绝
- 超时/未响应
- 忙线
- 挂断
- 服务端关闭房间
- 转接
- 扣费
- 挂起
- 充值
- IM消息
- 通知
- 礼物发送
- 鉴黄
- 设置
- 举报
- 随机匹配
- 前置条件
- 匹配建立
- 公共转私密
- 超时/未响应
- 挂断
- 扣费
- 挂起
- 充值
- IM消息
- 礼物发送
- 鉴黄
- 通话设置
- 用户举报
- 男男匹配
- 普通通话抢断匹配通话
- 匹配记录
- 卡片匹配
- 卡片类型
- 主播卡片
- 超级喜欢/爆灯主播
- 营销商品
- 匹配建立
- 匹配失败
- 匹配冻结
- 冻结解锁
- 匹配记录
- 卡片类型
- 视频匹配
- 匹配建立
- 匹配失败
- 超级喜欢/爆灯主播
- 营销商品
- 匹配冻结
- 冻结解锁
- 匹配记录
- 诱导消息
- 假视频
- 系统群发
IM聊天消息
- 主播搜索
- 会话列表
- 最近会话列表
- 陌生人会话列表
- 会话删除
- 系统通知列表
- 未读消息
- 最近消息列表
- 私聊
- 客服
- 消息发送/接收
- 文本消息（用户与币商）
- 图片消息（用户与币商）
- 语音消息
- 视频消息（用户与币商）
- 礼物消息
- 通话消息
- 匹配消息
- 关注消息
- 主播图片和视频解锁（用户与币商）
- 消息与系统通知翻译
- 消息/用户操作
- 消息复制、删除、举报
- 拉黑，举报
- 充值/订阅
- 推送通知
- 推送通知与勿扰模式设置
- 广播消息（送礼物、排行榜、中大奖）
- H5交互（通知、消息、等级、排行榜、活动等）
支付（订阅和购买）
- 商品列表
- 配置
- 金币商品
- 一次性购买金币
- 订阅金币
- 营销商品
- 营销商品
- 新人倒计时商品
- VIP订阅
- 匹配卡商品
- 一次性购买匹配卡
- 订阅匹配卡
- 货币本地化
- Google支付/Apple支付
- 配置
- 下单
- 支付
- 入账
- 补单
- 异常处理
- 测试
- 事件上报
- Adjust
- Firebase
- 触发场景
- 首页：金币促销
- 首页：切换国家
- 主播列表：拨打视频通话
- 主播资料页：拨打视频通话
- 主播资料页：相册解锁
- 个人中心：钱包金币订阅和购买
- 个人中心：会员订阅
- 设置：我的订阅
- IM聊天：礼物发送-金币弹窗
- IM聊天：消息发送失败-金币/VIP 提示语
- IM聊天：拨打视频通话
- IM聊天：购买主播视频或图片资源
- IM聊天：送礼物
- 假视频：拨打视频通话
- 系统弹窗：拨打视频通话
- 视频通话：切换/关闭摄像头
- 视频通话：送礼物
- 视频通话：挂起充值
- 系统通知：弹出VIP弹窗或者金币页面
- 卡片匹配/视频匹配/随机匹配：匹配卡购买以及订阅
- 卡片匹配和视频匹配冻结页面：会员订阅/金币订阅
- 卡片匹配和视频匹配营销商品
- 签到：金币订阅与匹配卡订阅
- 记录
- 我的订阅
- 充值记录
- 消费记录
- 三方支付
强制/非强制VIP逻辑
- 免费视频通话
- 免费消息
- 解锁国家
- 切换前后摄像头
- 头像框
- 尊贵身份
主播列表和资料
- 运营广告位（banner）
- 位置
- 匹配页面
- 动态列表
- 消息列表
- 主播列表
- 跳转类型
- App页面
- 外部浏览器
- 不跳转
- H5页面
- 位置
- 主播列表
- 推荐列表
- 新人列表
- 国家筛选
- 国家动态分组
- VIP订阅
- 排行榜
- 主播个人主页
- 主播资料
- 针对男用户查看男用户、主播、币商、机器人的不同显示处理规则
- 公开流业务
- 相册列表
- 礼物列表
- 动态列表
- 视频秀列表
- 用户操作（关注，举报、拉黑）
- 主播资料
动态与视频秀
- 动态列表
- 列表展示
- 动态翻译
- 图片预览
- 视频播放
- 动态详情
- 评论列表
- 评论与回复
- 动态举报/拉黑
- 视频秀列表
个人中心
- 签到
- 账户绑定（Android）
- 签到
- 签到按钮的不同展现与点击触发行为（一键领取、弹金币订阅弹窗、领取金币、弹匹配卡弹窗、领取匹配卡、无法点击）
- 订阅金币
- 订阅匹配卡
- 资料编辑
- 昵称编辑
- 年龄编辑
- 签名编辑
- 相册编辑
- 头像编辑
- 社交关系列表（好友、关注、被关注、黑名单）
- 设置
- 本地化/国际化
- 翻译语言与系统语言设置
- 缓存清理
- 环境切换
日志埋点
- 通话日志
- 业务日志
隔离规范
- 环境隔离
- 账户隔离
- 代码隔离