接手新项目让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、调度、回滚和观察项等。

相关推荐
工程小白菜2 小时前
ai-code-review 全链路:让 AI 来审 AI 的代码
ci/cd·ai编程
小虎AI生活2 小时前
8万星开源HyperFrames,我用WorkBuddy免费模型做了3条视频
aigc·ai编程
AI大模型-小华6 小时前
Codex 自动测试怎么用?从生成测试用例到修复失败用例
git·测试用例·ai编程·软件开发·codex·chatgpt pro·codex cli
huangfuyk6 小时前
前端融入/转后端避坑指南:AI 时代的安全边界、数据防线与实战细节
后端·ai编程
ZzT7 小时前
AI-SDLC 实践 06|开发阶段的知识库:Agent 写代码前该读哪些规则和业务知识
ai编程·claude
Bigger7 小时前
我扒了 GitHub Trending 前 20,8 个在做同一件事:给 Coding Agent 造基础设施
开源·github·ai编程
前端双越老师8 小时前
程序员 1v1 访谈系列第十六期:裸辞后失业半年了
前端·ai编程·全栈
可夫小子10 小时前
不换大模型、关掉深度思考:Hugging Face 用一个 LoRA 把 27B 编程能力拉到 64.7%
ai编程·facebook
ZhengEnCi19 小时前
AI 读不懂你的代码怎么办:用高价值注释消除曲解、过度优化与上下文膨胀
aigc·ai编程
ZhengEnCi20 小时前
AI 总模仿代码库里的过时写法怎么办:先清坏样例,再用类型与测试让 AI 无法犯错
人工智能·ai编程