后端交接注意事项
一、做了什么?
1.1 accountd
1.2 iot-cloud
iot 云服务项目
1.3 iot-device
1.4 note_go
1.5 oss
1.6 payment
1.7 shop
二、怎么做的?
2.1 账号
2.2 部署
2.3 配置(流程)
2.4 loT 相关设备资料
三、遇到什么问题?
TODO
四、怎么解决的?
TODO
五、交接文档(示例)
text
[项目名称]_交接材料/
├── 01_项目概况/
│ ├── 1.1_项目基本信息表.xlsx
│ ├── 1.2_项目架构图.png/.drawio
│ ├── 1.3_技术栈说明.md
│ └── 1.4_项目路线图.md
│
├── 02_代码仓库/
│ ├── 2.1_仓库清单.md
│ ├── 2.2_代码结构说明.md
│ ├── 2.3_分支策略.md
│ └── 2.4_代码规范检查清单.md
│
├── 03_开发环境/
│ ├── 3.1_环境搭建脚本/
│ │ ├── setup.sh / setup.ps1
│ │ ├── docker-compose.dev.yml
│ │ └── 依赖安装说明.md
│ ├── 3.2_配置文件模板/
│ │ ├── .env.example
│ │ ├── config.example.yaml
│ │ └── 配置项说明.md
│ └── 3.3_IDE配置/
│ ├── VSCode设置.json
│ ├── Goland配置导出.zip
│ └── 调试配置说明.md
│
├── 04_构建与部署/
│ ├── 4.1_构建脚本/
│ │ ├── Makefile
│ │ ├── build.sh / build.ps1
│ │ └── Dockerfile
│ ├── 4.2_部署文档/
│ │ ├── 部署流程.md
│ │ ├── 环境变量清单.md
│ │ └── 回滚操作手册.md
│ ├── 4.3_CI_CD配置/
│ │ ├── .gitlab-ci.yml / Jenkinsfile
│ │ ├── 流水线说明.md
│ │ └── 构建产物说明.md
│ └── 4.4_服务器清单/
│ ├── 服务器信息表.csv
│ └── 网络拓扑图.png
│
├── 05_数据库/
│ ├── 5.1_数据库设计/
│ │ ├── ER图.png/.mmd
│ │ ├── 表结构文档.md
│ │ └── 数据字典.xlsx
│ ├── 5.2_迁移脚本/
│ │ ├── migrations/
│ │ │ ├── 001_initial.sql
│ │ │ └── ...
│ │ └── 迁移工具说明.md
│ └── 5.3_维护脚本/
│ ├── 备份脚本.sh
│ ├── 清理脚本.sql
│ └── 性能优化建议.md
│
├── 06_API接口/
│ ├── 6.1_API文档/
│ │ ├── swagger.yaml
│ │ ├── postman_collection.json
│ │ └── API变更历史.md
│ ├── 6.2_核心接口说明/
│ │ ├── 认证鉴权接口.md
│ │ ├── 设备管理接口.md
│ │ ├── 数据上报接口.md
│ │ └── OTA升级接口.md
│ └── 6.3_第三方集成/
│ ├── 支付接口对接.md
│ ├── 短信服务对接.md
│ └── 对象存储对接.md
│
├── 07_业务逻辑/
│ ├── 7.1_业务流程图/
│ │ ├── 设备注册流程.png/.drawio
│ │ ├── 数据上报流程.png/.drawio
│ │ └── 告警处理流程.png/.drawio
│ ├── 7.2_状态机说明/
│ │ ├── 设备状态机.md
│ │ ├── 订单状态机.md
│ │ └── 告警状态机.md
│ └── 7.3_核心算法/
│ ├── 数据加密算法.md
│ ├── 消息路由算法.md
│ └── 重试机制说明.md
│
├── 08_运维监控/
│ ├── 8.1_监控配置/
│ │ ├── prometheus.yml
│ │ ├── grafana_dashboards/
│ │ │ ├── 设备监控.json
│ │ │ └── 服务监控.json
│ │ └── 监控指标说明.md
│ ├── 8.2_告警规则/
│ │ ├── alert_rules.yml
│ │ ├── 告警通知配置.md
│ │ └── 告警处理手册.md
│ ├── 8.3_日志管理/
│ │ ├── 日志配置文件/
│ │ │ ├── logback.xml
│ │ │ └── logrotate.conf
│ │ ├── 日志查询语句.md
│ │ └── 日志分析案例.md
│ └── 8.4_性能数据/
│ ├── 压测报告.pdf
│ └── 性能瓶颈分析.md
│
├── 09_安全配置/
│ ├── 9.1_访问控制/
│ │ ├── 权限矩阵.xlsx
│ │ ├── RBAC配置.md
│ │ └── API鉴权说明.md
│ ├── 9.2_证书管理/
│ │ ├── SSL证书信息.md
│ │ ├── 证书更新记录.md
│ │ └── 证书备份/
│ └── 9.3_安全扫描/
│ ├── 漏洞扫描报告.pdf
│ └── 安全加固建议.md
│
├── 10_故障处理/
│ ├── 10.1_常见故障/
│ │ ├── 故障1_数据库连接池耗尽.md
│ │ ├── 故障2_消息队列堆积.md
│ │ └── 故障3_内存泄漏处理.md
│ ├── 10.2_应急手册/
│ │ ├── 服务降级方案.md
│ │ ├── 数据恢复流程.md
│ │ └── 灾难恢复计划.md
│ └── 10.3_oncall记录/
│ ├── 历史故障记录.xlsx
│ └── 值班交接模板.md
│
├── 11_技术债务/
│ ├── 11.1_已知问题清单.xlsx
│ ├── 11.2_待重构模块说明.md
│ └── 11.3_技术选型评估报告.md
│
├── 12_测试相关/
│ ├── 12.1_测试用例/
│ │ ├── 单元测试覆盖报告.md
│ │ ├── 集成测试用例.xlsx
│ │ └── 压力测试脚本/
│ ├── 12.2_测试数据/
│ │ ├── 测试账号密码.md
│ │ └── Mock服务配置.md
│ └── 12.3_测试环境/
│ ├── 测试环境访问方式.md
│ └── 测试数据构造脚本/
│
├── 13_项目文档/
│ ├── 13.1_设计文档/
│ │ ├── 概要设计文档.pdf
│ │ └── 详细设计文档.pdf
│ ├── 13.2_会议记录/
│ │ └── 重要决策记录.md
│ └── 13.3_相关链接/
│ ├── Confluence页面列表.md
│ └── 项目管理工具链接.md
│
├── 14_联系人清单/
│ ├── 14.1_项目组成员.md
│ ├── 14.2_依赖团队联系人.md
│ └── 14.3_第三方服务支持.md
│
└── 15_交接确认/
├── 15.1_交接检查清单.xlsx
├── 15.2_知识传递记录.md
└── 15.3_权限转移确认书.pdf