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

相关推荐
season_zhu1 小时前
Skills For Real Engineers 系列之三:需求聊清楚了,怎么一步步走主流程,做到交付?
ios·ai编程
ZzT1 小时前
vibe coding 做小游戏·素材篇:Claude Code 操作网页版 ChatGPT,一个对话画完全套美术
ai编程·游戏开发
程序员cxuan1 小时前
别学 subagent 了,很可能要凉了。
后端·agent·ai编程
前端双越老师2 小时前
程序员 1v1 访谈系列第九期:要不要晋升管理层?
agent·ai编程·全栈
野生的码农3 小时前
能工智人,40 大寿,尚能班否?
android·ai编程
一拳不是超人4 小时前
用了两周,我给 DeepSeek Harness 写了 5 个插件
人工智能·ai编程·deepseek
king王一帅4 小时前
给你的编辑器加上思维导图、流程图、白板:一套开源组件,多种文档通用
前端·vue.js·ai编程
LV技术派4 小时前
【成为 AI Native Builder · 01】开篇:为什么 AI 总在返工?
人工智能·程序员·ai编程
ZhengEnCi13 小时前
如何审核 AI 生成的代码:一份可落地的 6 层检查清单
ai编程·代码规范
张晓宇 .14 小时前
Codex 不显示新模型怎么办?GPT-6.1 Terra 上线后的排查教程:版本、自定义模型目录与 API 支持
人工智能·gpt·大模型·ai编程·codex·deepseek