docs: 重构文档结构,分离学习笔记和 MVP 架构设计
**变更概述:** - 将 MVP 架构设计文档独立到项目根目录 `mvp/` - 整理 `docs/` 为纯学习和分析文档目录 - 按类型分类:learning(学习)、analysis(分析)、reports(报告)、guides(指南) **目录结构:** ``` mvp/ # MVP 架构设计(独立) ├── README.md # 数据库设计总览 ├── architecture/ # 架构文档 │ ├── agent-architecture-mvp.md │ ├── implementation-plan.md │ └── ... └── tables/ # 数据表设计 docs/ # 学习和分析文档 ├── learning/ # 学习笔记(00-08 编号) ├── analysis/ # 分析笔记 + 重构计划 ├── reports/ # 临时报告 └── guides/ # 指南文档 ``` **详细变更:** - docs/README.md → mvp/README.md(数据库设计入口) - docs/architecture/ → mvp/architecture/(架构设计) - docs/tables/ → mvp/tables/(数据表设计) - docs/学习笔记-*.md → docs/learning/07-*.md, 08-*.md - docs/项目学习路径.md → docs/learning/00-*.md - docs/功能分析报告.md → docs/analysis/ - docs/修复报告-*.md → docs/reports/ - docs/日志配置*.md → docs/guides/ 或 docs/reports/ - docs/design/ → docs/analysis/(问题分析和重构计划)
This commit is contained in:
+79
-52
@@ -1,81 +1,108 @@
|
||||
# 数据库设计文档索引
|
||||
# 文档索引
|
||||
|
||||
## 📂 文档结构
|
||||
## 📂 目录结构
|
||||
|
||||
```
|
||||
docs/
|
||||
├── README.md # 总览(推荐从这里开始)
|
||||
├── database-design.md # 总览(同 README.md)
|
||||
├── README.md # 项目文档总览
|
||||
├── INDEX.md # 本索引文件
|
||||
│
|
||||
├── tables/ # 表设计详细文档
|
||||
│ ├── diagnosis_record.md # 诊断记录表(核心)
|
||||
│ ├── case_library.md # 案例库表
|
||||
│ └── api_document.md # 文档元数据表
|
||||
├── learning/ # 📚 学习笔记(个人学习理解)
|
||||
│ ├── 00-项目学习路径.md
|
||||
│ ├── 01~08-*.md # 按学习顺序编号
|
||||
│ └── README.md
|
||||
│
|
||||
└── architecture/ # 架构设计文档
|
||||
├── agent-architecture-mvp.md # ⭐ Agent 架构 MVP 精简版
|
||||
├── agent-architecture.md # Agent 架构完整版(含生产级扩展)
|
||||
├── session-management.md # 会话管理设计
|
||||
└── implementation-plan.md # 实施规划
|
||||
├── analysis/ # 🔍 分析笔记(代码/问题分析)
|
||||
│ ├── essence-report-*.md
|
||||
│ ├── explore-report.md
|
||||
│ ├── chunking-issues-analysis.md
|
||||
│ └── 功能分析报告.md
|
||||
│
|
||||
├── reports/ # 📝 临时报告(修复/验证报告)
|
||||
│ ├── 修复报告-*.md
|
||||
│ ├── 验证报告-*.md
|
||||
│ └── 日志配置完成总结.md
|
||||
│
|
||||
└── guides/ # 📖 指南文档
|
||||
└── 日志配置与分析指南.md
|
||||
```
|
||||
|
||||
**⚠️ 注意:MVP 架构设计文档已移至项目根目录 `../mvp/`**
|
||||
|
||||
查看 [mvp/README.md](../mvp/README.md) 了解 MVP 架构、数据库设计、实施计划等。
|
||||
|
||||
---
|
||||
|
||||
## 🚀 快速导航
|
||||
|
||||
### 我是新人/学习者
|
||||
1. [项目学习路径](learning/00-项目学习路径.md) - 从这里开始
|
||||
2. [learning/README.md](learning/README.md) - 学习笔记索引
|
||||
3. 按编号顺序阅读 `learning/` 目录下的文档
|
||||
|
||||
### 我是开发者
|
||||
1. [总览](README.md) - 了解整体设计
|
||||
2. [diagnosis_record](tables/diagnosis_record.md) - 核心业务表
|
||||
3. [实施规划](architecture/implementation-plan.md) - 开发计划
|
||||
👉 **MVP 架构设计文档已移至 `../mvp/`**
|
||||
|
||||
### 我是运维
|
||||
1. [总览](README.md) - 了解表结构
|
||||
2. [实施规划](architecture/implementation-plan.md) - 部署检查清单
|
||||
请查看 [mvp/README.md](../mvp/README.md) 了解:
|
||||
- MVP 架构设计
|
||||
- 数据库设计和表结构
|
||||
- 实施规划(Phase 1/2/3)
|
||||
- 会话管理设计
|
||||
|
||||
### 我是产品
|
||||
1. [总览](README.md) - 了解系统定位
|
||||
2. [会话管理](architecture/session-management.md) - 了解用户交互流程
|
||||
### 我要查看分析报告
|
||||
1. [分析笔记目录](analysis/) - 代码分析和问题分析
|
||||
2. [临时报告目录](reports/) - 修复和验证报告
|
||||
|
||||
---
|
||||
|
||||
## 📋 表清单
|
||||
## 📚 学习笔记 (learning/)
|
||||
|
||||
| 表名 | 优先级 | 文档 | 说明 |
|
||||
|------|--------|------|------|
|
||||
| diagnosis_record | P0 | [查看](tables/diagnosis_record.md) | 诊断记录(核心) |
|
||||
| case_library | P0 | [查看](tables/case_library.md) | 案例库 |
|
||||
| api_document | P0 | [查看](tables/api_document.md) | 文档元数据 |
|
||||
按学习顺序编号,建议按顺序阅读:
|
||||
|
||||
1. [00-项目学习路径](learning/00-项目学习路径.md)
|
||||
2. [01-AI-Ops-核心设计-Essence报告](learning/01-AI-Ops-核心设计-Essence报告.md)
|
||||
3. [02-outputKey-深度解析](learning/02-outputKey-深度解析.md)
|
||||
4. [03-核心疑问解答](learning/03-核心疑问解答.md)
|
||||
5. [04-RAG-分块策略-Essence报告](learning/04-RAG-分块策略-Essence报告.md)
|
||||
6. [05-文件上传自动索引-Essence报告](learning/05-文件上传自动索引-Essence报告.md)
|
||||
7. [06-RAG查询流程-Essence报告](learning/06-RAG查询流程-Essence报告.md)
|
||||
8. [07-Tool定义方式对比与优化](learning/07-Tool定义方式对比与优化.md)
|
||||
9. [08-MethodToolCallback-vs-ToolCallingManager深度分析](learning/08-MethodToolCallback-vs-ToolCallingManager深度分析.md)
|
||||
|
||||
---
|
||||
|
||||
## 📖 阅读建议
|
||||
## 🔍 分析笔记 (analysis/)
|
||||
|
||||
### 第一次阅读
|
||||
```
|
||||
1. README.md(10分钟)
|
||||
- 了解设计原则
|
||||
- 了解表关系
|
||||
|
||||
2. diagnosis_record.md(15分钟)
|
||||
- 核心表设计
|
||||
- 字段泛化设计
|
||||
|
||||
3. implementation-plan.md(5分钟)
|
||||
- 分阶段实施计划
|
||||
```
|
||||
代码分析和问题分析文档:
|
||||
|
||||
### 深入理解
|
||||
```
|
||||
- case_library.md - 案例推荐机制
|
||||
- api_document.md - 文档管理设计
|
||||
- session-management.md - 会话管理机制
|
||||
```
|
||||
- [essence-report-rag.md](analysis/essence-report-rag.md)
|
||||
- [essence-report-rag-chunking.md](analysis/essence-report-rag-chunking.md)
|
||||
- [explore-report.md](analysis/explore-report.md)
|
||||
- [chunking-issues-analysis.md](analysis/chunking-issues-analysis.md)
|
||||
- [功能分析报告.md](analysis/功能分析报告.md)
|
||||
|
||||
---
|
||||
|
||||
## 📝 临时报告 (reports/)
|
||||
|
||||
修复报告和验证报告:
|
||||
|
||||
- [修复报告-多轮对话时间查询缓存问题](reports/修复报告-多轮对话时间查询缓存问题.md)
|
||||
- [验证报告-时间查询问题](reports/验证报告-时间查询问题.md)
|
||||
- [日志配置完成总结](reports/日志配置完成总结.md)
|
||||
|
||||
---
|
||||
|
||||
## 📖 指南文档 (guides/)
|
||||
|
||||
- [日志配置与分析指南](guides/日志配置与分析指南.md)
|
||||
|
||||
---
|
||||
|
||||
## 🔄 文档维护
|
||||
|
||||
- 原完整文档已备份:`database-design-backup-20240622.md`
|
||||
- 每个表的详细设计在 `tables/` 目录
|
||||
- 架构设计在 `architecture/` 目录
|
||||
- 修改表结构时,同步更新对应 Markdown
|
||||
- **学习笔记** 放在 `learning/` 目录,按编号顺序命名
|
||||
- **分析笔记** 放在 `analysis/` 目录
|
||||
- **临时报告** 放在 `reports/` 目录
|
||||
- **指南文档** 放在 `guides/` 目录
|
||||
- **MVP 架构设计** 已移至项目根目录 `../mvp/`(包含架构、数据库、实施计划)
|
||||
|
||||
Reference in New Issue
Block a user