一.在非交接状态下,需要做好的事情
- 必要的代码注释
- 必要的文档梳理
- readme即可,记录重要的信息
- 方便自己查阅、方便新的伙伴快速了解项目
二.交接readme
2.1项目相关的网址
- 项目git地址
- 不同环境的访问权限(或者对应的测试账号/密码)
- 接口文档地址,如yapi
- 项目发版权限,如devops具体权限
- 需求文档list
- 原型文档list
- bug管理地址,如jira地址
- 性能监测网站
- 埋点数据统计网站
- oss存储地址
- nginx在线配置地址
2.2项目情况
- 项目功能、使用人员、对标竞品等,有系统操作手册、系统录屏最佳
- 上下游系统的依赖情况
- 项目目前进度、后续计划、之前遗留的待优化内容等
- 技术方面的待优化事项
- 需求任务迭代情况
2.3具体相关规范/约定
- git分支管理规范
- 发版规范
- 接口规范,以及与后端的其余约定
- 一些通用的交互、展示规范
2.4技术方面
- 使用的非常见第三方类库介绍+官网地址
- 黄金流程的架构图、流程图 ⭐️⭐️
- 现有公共组件、公共方法的支持
- 如果有全局覆盖方法的话,一定要提醒!!!⭐️⭐️
- 有哪些坑,以及如何避免 ⭐️⭐️