接手新项目让AI生成辅助文档一览(后端)

本文档目录面向新接手同学,按使用场景分类组织。

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、调度、回滚和观察项等。

相关推荐
Ai拆代码的曹操10 分钟前
Agent 做错了怎么办?Self-Critique 机制拆解
后端·agent·ai编程
9i编程17 分钟前
16G 内存带不动 Milvus:用 opencode 重写私文简搜聊天版(上篇)
人工智能·openai·ai编程
寒蝉12834 分钟前
我要的不是更强的 AI,而是更懂我的 AI
ai编程
唐老板1 小时前
从 CodeBuddy 到 WorkBuddy:腾讯的逆袭
ai编程
weixin_431600442 小时前
为什么 Agent REPL 要上 Ink:好处、用法与内部设计
前端·学习·ai·agent·ai编程
W_chuanqi2 小时前
VSCode + Claude Code + DeepSeek:打造 AI 编程神器
ide·vscode·编辑器·ai编程
蒸蒸yyyyzwd2 小时前
cpp 选手 转 ai 后端学习笔记
c++·transformer·ai编程
北方的银狐-Zero2 小时前
国内大厂都在吹的“本体产品“,到底假在哪儿?
人工智能·ai编程·本体论
大侠Luffy11 小时前
一行代码没写,我用AI做了一个可以收费产品
chatgpt·ai编程·vibecoding
Patrick在香港12 小时前
Python Docker镜像从1.2GB到89MB:多阶段构建的完整优化实录
java·python·docker·信息可视化·容器·数据分析·ai编程