出行应用文档中心

# 交付项目启动Checklist

版本 日期 更改人 描述
1.0.0 2020-12-06 初始化

[toc]

# 1.TAPD

TAPD使用tapd.cn。联系管理员(jorge, chrisxd, celine, billy, shouxu)新建TAPD项目。 项目完成后，更新项目应用，按顺序保留：WiKi，需求，任务，缺陷，迭代，文档 TAPD首页保留所有类型文档的索引。 所有的文档分类控制权限 内容包括但不局限于：

  1. [所有人]测试环境/预生产环境/生产环境链接，及各个环境的测试账号信息

  2. [所有人] API文档

  3. [管理员&运维]云资源列表，包括网络规划，云资源，账号信息等

  4. [管理员&运维]分环境资源类配置，分环境服务类配置，分环境分模块docker版本和自定义配置

  5. [所有人]Release Note

  6. [所有人] Q&A手册

# 2. 开发流程

  1. 开发流程 项目迭代开发至少包括以下步骤: a. 需求评审 --责任人： 产品经理，参与人：研发，测试 b1. 研发 --责任人：研发同学 b2: 测试用例评审 --责任人：测试经理，参与人：产品经理，研发 c. 研发集成测试 --责任人：研发 d. 系统测试 --责任人：测试，研发 e. 产品体验 --责任人：产品经理 f. RCB(Release Control board) --责任人：项目经理，研发经理，产品经理，测试经理 g. 上线
  2. 研发开始清必须输出：功能模块时序图，数据库SQL， 第三方依赖列表
  3. 开发、测试状态通过TAPD流转驱动

# 3.接口文档

各个模块接口文档以版本号进行管理。

# 3.1 版本号规则

版本号的格式为 X.Y.Z(又称 Major.Minor.Patch)，递增的规则为： X 表示主版本号，当 API 的兼容性变化时，X 需递增。 Y 表示次版本号，当增加功能时(不影响 API 的兼容性)，Y 需递增。 Z 表示修订号，当做 Bug 修复时(不影响 API 的兼容性)，Z 需递增。

# 3.2 接口文档规范

  1. 更新历史
  2. 功能概述
  3. 分场景时序图
  4. 接口文档list

# 3.3 接口方式

RESTFull API (GET, POST, PUT, Delete)

  1. 不用大写字母
  2. 不用_， 可以用-
  3. URL中只使用名词，搜索除外。
  4. URI规则: /[模块名]/v[版本号]/uri_tail

# 3.4 HTTP返回码

➢ 200：Success ➢ 400：Bad request ➢ 401: Unauthorized ➢ 403: Forbidden ➢ 404：Not found ➢ 500: Internal service error ➢ 504: Gateway timeout

# 3.5 Method

➢ GET： ➢ POST：请求Body为JSON ➢ PUT：请求body为JSON

# 3.6 Response

# 3.6.1 基础返回结构
{
    "code":0,
    "msg":"success",
    "data":{
    }
}
1
2
3
4
5
6

code: 业务内统一错误码，业务自行定义。0：代表返回成功 msg: 返回描述 data: 返回数据的结构体

# 3.6.2 列表返回结构
{
    "code":0,
    "msg":"success",
    "data":{
        "total":100,
        "page":1,
        "pageSize":10,
        "list":[

        ]
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

code: 业务内统一错误码，业务自行定义。0：代表返回成功 msg: 返回描述 data: 返回数据的结构体 data.total: 总条数 data.page: 当前页码 data.pageSize: 每页条数 data.list: 列表

# 4. Release Note在线文档

启动项目后建一个Release Note发布计划文档. 每次迭代上线需要在Release Note中根据发布迭代梳理：

  1. 上线环境
  2. 上线时间
  3. 测试用例(功能测试，全功能冒烟测试，安全测试用例，性能测试用例，测试数据)和测试报告
  4. 上线过程中影响
  5. 上线后影响
  6. 回滚方案
  7. 上线各个模块docker的镜像Id, 配置文件版本号，上线代码tag
  8. 上线需求列表 需要包括TAPD上需求标题，链接
  9. [optional]提供上线后历史数据清理脚本
  10. [optional]提供上线后测试数据清理

# 5. 交付腾讯云账号

联系客户开通用于交付的腾讯云账号，根据预估云资源列表，开通相关资源的管理权限。

# 6. APP相关账号

有APP相关开发的功能需要在启动开发后一个月的完成相关账号申请。 具体可以咨询tiara。

  1. App Store账号：
  2. Android各大应用市场的账号
  3. App上架材料 a. APP名称（30字以内）-必须 b. 副标题（30字以内） c. 价格 d.宣传文本（200字以内） e.描述（4000字以内）-必须 f. 关键字（100字以内）-必须
  4. APP logo
  5. 应用市场中的APP展示图片
  6. 加盖企业公章的企业营业执照扫描件 部分平台需提供企业法人身份认证材料
  7. Privacy Policy用户隐私政策 APP用户注册过程需要，需客户法务审核通过
  8. APP software copyright申请软件著作权 a. 仅安卓市场上传需要. b.软件著作权证明申请时间较长，建议通过淘宝代办机构申请.(涉及费用) c. 申请软著需腾讯侧提供： c.1 Sample Source Code pieces. c.2 APP需求文档.（PRD）
  9. IOS：全功能现场视频
  10. Android：除应用市场上架外，还需提供通过QR code扫码下载途径

# 7. 微信公众账号相关

有微信公众账号相关开发的功能需要在启动开发后10天内的完成相关账号申请。

  1. 微信公众账号
  2. JS安全域名
  3. 模板消息规划

# 8. 企微账号相关

有企微相关开发的功能需要在启动开发后10天内的完成相关账号申请。

  1. 注册企业
  2. 注册应用

# 9. 网络规划

开发前针对不同的环境(测试环境/预生产环境/生产环境)做好网络规划。 建议：

  1. 每个环境单独VPC。
  2. 运维类单独VPC，[待定]每个环境单独部署
  3. 请求接入CLB， 出口为NAT。所有内网服务器均不提供外网IP
  4. 接入的C端域名，接入到WAF，然后HTTP回源到CLB
  5. 内网访问建议走HTTP，如果需要HTTPs的特殊场景，单独考虑
  6. 涉及与外部VPC打通，使用独立VPC处理，注意不要出现VPC网络和TKE网络冲突
  7. 建议优先考虑使用TKE。

# 10. 域名和证书准备

  1. 开发前针对项目规划域名
  2. 辅助客户进行域名备案
  3. 申请域名证书 3.1 测试环境使用TrustAsia 域名型(DV)通配符 3.2 预生产环境和生产环境使用GlobalSign 企业型通配符 （OV）SSL证书
  4. C端接入层域名按照端统一。

# 11. 运维服务器

统一申请运维服务器，用于日常代码打包，发版，基础组件运维等。

# 12. 模块化要求

对于所有的业务闭环系统（例如积分商城），申请在线文档，维护发布信息，包括： 基础信息：

  1. 系统版本Release Note
  2. 系统最新版本功能介绍
  3. 系统最新版本架构设计
  4. 系统最新版本的接口文档
  5. 系统最新版本的资源需求
  6. 系统最新版本的第三方依赖组件（组件名称，版本，接口）列表
  7. 系统最新版本镜像和配置
  8. 系统最新版本的压测数据
  9. 系统安装指导

分版本

  1. 系统版本
  2. 版本需求
  3. 版本设计文档
  4. 系统镜像和配置文件
  5. 系统版本代码Tag
  6. 版本测试报告
lastUpdate: 1/16/2022, 1:07:52 AM

开发规范 →