2018年入职某公司,接手一大哥的前端项目,几乎无任何交接文档,催也不给,无奈之下只好当面沟通交流,前后问了很多问题,导致双方又累又不开心。 后来风水轮流转,2020年的时候,他来接手我的一个前端项目,我得知是他接手的时候,并没有准备报复,反而尽可能将交接文档写的完整清晰,这次的交接就比之前顺利的太多太多。 一前一后的对比,希望他能提高自己的这方面意识,毕竟工作不仅仅是coding,也需要这种必要的软技能。
方便你我他
将自己的项目交接给别人,不管这个项目目前状况如何,毕竟都是自己的心血,肯定都是希望对方善待这个项目。 交接文档写的详细,既是方便了他人了解项目,也尽可能的避免接手人再来打扰自己 将项目中的readme文件,写的足够完善,项目交接就完成了一大半。 对于接手一个项目的话,也是如此,如果交接人的文档不够细致,可按照本文的list让其有方向的准备
在非交接状态下,需要做好的事情
- 必要的代码注释
- 必要的文档梳理
- 方便自己查阅、方便新的伙伴快速了解项目
交接readme
项目相关的网址 ????
以及相关权限帮忙开通、或告知权限申请方法/对接人
- 项目git地址
- 不同环境的访问权限(或者对应的测试账号/密码)
- 接口文档地址,如yapi
- 项目发版权限,如devops具体权限
- 需求文档list
- 原型文档list
- bug管理地址,如jira地址
- 性能监测网站
- 埋点数据统计网站
- oss存储地址
- nginx在线配置地址
项目情况 ??
- 项目功能、使用人员、对标竞品等,有系统操作手册、系统录屏最佳
- 上下游系统的依赖情况
- 项目目前进度、后续计划、之前遗留的待优化内容等
- 技术方面的待优化事项
- 需求任务迭代情况
团队情况 ????
- 产品、后端、测试对接人员备注,需要同时备注erp的用户名
- 如果方便的话,带领当面认识一下
具体相关规范/约定 ????
- git分支管理规范
- 发版规范
- 接口规范,以及与后端的其余约定
- 一些通用的交互、展示规范
技术方面
- 使用的非常见第三方类库介绍+官网地址
- 黄金流程的架构图、流程图 ????
- 现有公共组件、公共方法的支持
- 如果有全局覆盖方法的话,一定要提醒!!!????
- 有哪些坑,以及如何避免 ????
实操方面
- 项目跑起来
- 项目上线一次(至少测试环境上线一次) ????
最后
- 交接之前的发现的bug,可以修改完成了再交接,交接之后发现的bug,就归属于新同事了,交接完成之后,项目就与前任无关了。
|