本文档目录面向新接手同学,按使用场景分类组织。
1、总览
项目交接说明(overview/project-overview.md):项目定位、模块职责、业务线和推荐阅读顺序。
2、入门
本地开发指南(getting-started/development-guide.md):本地环境、构建、启动、profile 和配置注意事项。
代码导航手册(getting-started/code-navigation.md):遇到需求或问题时,从哪个模块、哪个包开始查。
3、业务流程
4、 架构与依赖
模块依赖关系图(architecture/module-dependency-map.md):模块边界、调用方向和依赖关系。
核心数据模型(architecture/database-model.md):支付、商户、金融主体、二维码、签约等核心表说明。
外部依赖清单(architecture/external-dependencies.md):Dubbo 外部服务、支付通道、中间件和配置入口。
5、运维与排障
调度任务与消息消费(operations/scheduler-and-mq.md):XXL-JOB、RocketMQ、导出任务和消费链路。
常见问题排查手册(operations/troubleshooting.md):
6、变更与发布
常见需求改动手册(playbooks/change-playbook.md):新增字段、渠道、任务、MQ、数据库字段等改动入口。
发布检查清单(release/release-checklist.md):上线前配置、DB、调度、回滚和观察项等。