# 文档导航

本文档用于规划本仓库后续的中文文档体系，便于未来接入 `VitePress` 后直接上线阅读。

## 目录规划

### `docs/00-文档导航.md`

- 文档首页
- 仓库文档阅读顺序
- 面向读者的快速导航

### `docs/10-架构设计/`

- 记录项目整体设计、技术选型、架构原则
- 适合写“为什么这样设计”

当前计划：

- `01-个人简历-monorepo-重构总方案-v1学习版.md`
- `02-为什么避免双后端.md`
- `03-文档目录规划与-VitePress-计划.md`
- `04-空应用脚手架策略说明.md`
- `08-AI-Intro-与-LangGraph-多域-RAG-架构决策草案.md`
- `07-my-resume-源码学习拆解/`

其中可继续细分一组“源码学习拆解”文档，专门沉淀：

- `server` 后端链路理解
- `admin` 后台前端链路理解
- `web` 公开站前端链路理解
- 以及后续按模块持续补的源码走读记录

### `docs/20-研发流程/`

- 记录 GitHub 协作流程、里程碑管理、Issue 规范、开发日志模板
- 适合写“我们如何一步步做”

当前计划：

- `01-GitHub-标准开发流程.md`
- `02-里程碑与-Issue-拆解建议.md`
- `03-开发日志模板.md`
- `04-测试策略与质量门禁.md`
- `05-GitHub-Actions-最小-CI-流程.md`
- `06-M15-AI-RAG-里程碑与-Issue-规划.md`
- `07-M17-M19-ai-talk-里程碑与-Issue-规划.md`
- `08-M16-follow-up-性能优化专题-Issue-草案.md`
- `09-M23-数字人简历问答-里程碑预研与选型.md`
- `10-M24-RAG-检索与召回质量-里程碑规划.md`
- `10-版本发布与-CHANGELOG-流程.md`
- `11-M25-M26-AI-Intro-与-LangGraph-多域-RAG-Issue-草案.md`

### `docs/30-开发日志/`

- 每个 Issue 完成后沉淀一篇开发日志
- 后续教程、博客、分享优先从这里提炼

命名建议：

- `M1-issue-01-workspace-初始化.md`
- `M1-issue-02-apps-与-packages-占位骨架.md`
- `M1-issue-03-共享配置占位.md`
- `M1-issue-04-空应用脚手架策略说明.md`

### `docs/40-教程与博客/`

- 记录里程碑级教程、技术博客或至少先整理好的大纲
- 优先由开发日志提炼而来

当前计划：

- `M2-鉴权与角色-最小登录闭环-教程大纲.md`
- `M3-双语内容模型到公开展示闭环-教程大纲.md`
- `M4-AI-工具链从-Provider-到角色边界-教程大纲.md`
- `M5-导出与下载从-Markdown-到-PDF-教程大纲.md`
- `M6-测试-CI-CD-与部署上线-教程大纲.md`
- `M7-展示层与内容接入从联调壳到真实页面-教程大纲.md`
- `M8-从内存态到可持续演进-阶段总结大纲.md`
- `M9-主题边界到共享-UI-从可用到可继续设计-教程大纲.md`
- `M10-AI-工作台从基础接口到后台闭环-教程大纲.md`
- `M20-AI-简历优化-Rich-Loading-与独立结果页-教程大纲.md`
- `M22-API-响应契约标准化与渐进兼容-教程大纲.md`
- `M22-NestJS-Swagger-接入与接口注解统一-教程大纲.md`

### `docs/40-部署上线/`

- 记录 CI/CD、Vercel、云服务器、Nginx、HTTPS 等

当前计划：

- `01-Vercel-与-云服务器-最小部署说明.md`
- `02-开源版发布前检查清单.md`
- `03-GitHub-Actions-连接-ECS-发布说明.md`
- `04-ECS-首次上线验收清单.md`
- `05-ECS-Image-模式部署教程-从本地构建到上线.md`

### `docs/50-教程文章/`

- 面向外部读者的成体系教程稿
- 可由开发日志整理后沉淀而来

当前已补充：

- `10-M23-从流式-API-到全局-AI-Chat-Drawer-为什么先做公开站-MVP-闭环.md`

### `docs/60-源码拆解/`

- 记录结合真实源码的讲解式拆解
- 适合在学习某条调用链、某个模块协作方式时逐段阅读

当前计划：

- `01-admin-简历保存链路-全景与草稿落库.md`
- `06-M22-AI-简历导入识别-时序图与优化路线.md`
- `07-M22-简历导入识别-12轮源码演进.md`
- `08-RAG-检索与问答-管线与重排拆解.md`
- `09-M23-AI-Chat-流式对话与治理闭环源码梳理.md`
- `M25-AI-Intro-页面源码拆解.md`

## 命名规范

- 文档文件名统一使用**中文为主**
- 使用编号保证排序稳定
- 文件名建议格式：
  - `01-主题名.md`
  - `02-主题名.md`
- 若主题包含英文技术名，保留必要英文，例如：
  - `01-GitHub-标准开发流程.md`
  - `03-文档目录规划与-VitePress-计划.md`

## 写作顺序建议

- 先写架构与流程文档
- 再按 Issue 产生开发日志
- 再按里程碑提炼教程 / 博客或至少先写大纲
- 最后整理成面对外部读者的教程文章

## 当前正式收尾推荐入口

如果你的目标是准备对外开源发布，建议优先看：

1. `README.md`
2. `docs/README.md`
3. `docs/40-部署上线/02-开源版发布前检查清单.md`
4. `docs/40-部署上线/01-Vercel-与-云服务器-最小部署说明.md`

## VitePress 接入建议

- 未来增加 `docs/.vitepress/`
- 首页直接引用本目录结构
- 侧边栏按 `10/20/30/40/50/60` 分组即可
