金三银四做好交接

724 阅读2分钟

项目背景

金三银四大家都想这怎么面试,某天接手离职同事的项目后,发现诸多问题,想到应该整理一份交接文档 这个是一个模版,已经去掉敏感信息

  • 开始是MySQL后来转成oracle
  • 项目状态:已上线

项目人员

  • 项目经理:xxx
  • 前端:xxx
  • 客户技术:xxx xxx@xxx.com

编码约定

1.数据库均有字段created_time和updated_time

2.接口命名为IxxxxService ,实现类命名为xxxxService

3.静态变量全部大写字母,单词间用_分隔

更新内容(2020-04-12)

  1. 加入支付宝和小程序调用客户端

  2. 加入swagger接口文档生成工具,生产环境通过配置文件关闭即可

    • 演示demo:在 SwaggerDemo.java中
    • 文档名:在 application-dev.xml文件中 doc配置就能修改文件名
  3. 加入spring cache注解式缓存

    • 演示demo:在SpringCacheDemo.java中
  4. cdn key配置

    • 在配置文件中:cdn:key是对应的上传key,根据项目变化
  5. 启动参数

    • 启动时,需要通过环境变量指定配置文件
    • 开发:spring.profiles.active=dev
    • 生产:spring.profiles.active=prod

业务模块、包结构介绍

项目共性包团队内部都知道,一般都不用写,这里写项目个性的

项目特性包com.xxx 关键service类的业务关键地方说明

维护注意事项

比较坑的地方

后续维护可优化

做的不好的,有时间可以优化的

环境配置说明

生产环境 准生产环境 测试环境

部署说明

服务器在哪里,账号

分支管理

公司Git仓管管理规范:

  • 必要分支:master、release、develop
  • 新功能开发最好新建一个分支,避免开发过程中遇到线上问题需要紧急修复发版;也可遇到显示问题需要紧急发版时从发版分支拉取出一个新的hotfix
  • 用完分支确定不要之后需删除,避免分支过多不利于维护。
  • 其他分支说明:。

java版本:

1.8

交接记录

  • xxx离职小伙伴交接,已经上传完代码,与线上一直
  • 登录测试、准生产、生产 数据库、测试服务器账号都正常。20200412