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

相关推荐
zhangfeng11335 小时前
华为云 MaaS GLM-5.2 完整指南(踩坑实录)
人工智能·华为云·ai编程
coft6 小时前
Pi Agent 的 Token 成本控制:为什么核心是 Prompt Cache 前缀稳定性
prompt·ai编程·ai agent·pi agent
coft6 小时前
Pi Agent 长任务处理:从工具超时到会话恢复的六层机制
ai编程·ai agent·pi agent
全栈弄潮儿16 小时前
AI 编程中的隐私与安全:哪些信息不要提交
安全·openai·ai编程
必须会一定会17 小时前
AI 编程工具选型:Cursor、Claude Code、Codex、OpenCode 与 DeepSeek Harness 的产品形态和成本边界
人工智能·ai编程
wangruofeng18 小时前
OpenAI 断供 Cursor:这不是商业决定,是战争行为
openai·ai编程·cursor
码哥字节19 小时前
你的PPT交给人改还是发链接?41k星Skill相反
ai编程
小江的记录本19 小时前
【AI Agent】《2026年9月 AI Agent全栈开发技术选型专项面试宝典》
java·spring boot·python·spring·ai·面试·ai编程
魔术师Grace21 小时前
调用一次大模型,就算 Agent 吗?
aigc·agent·ai编程
zandy10111 天前
网络支付合规三重门:Kimi Code、Cursor、GitHub Copilot等五款AI编程工具国内实战测评
github·copilot·ai编程