zhuyongxin
584639fa2a
Relocate RAG and diagnosis decision/E2E writeups from docs/ root into mvp/engineering so architecture, issues, and engineering narrative stay together. Update indexes and cross-links; leave docs/learning as legacy.
76 lines
3.0 KiB
Markdown
76 lines
3.0 KiB
Markdown
# 文档索引
|
||
|
||
**更新日期**：2026-07-29
|
||
|
||
## 目录结构
|
||
|
||
```text
|
||
docs/
|
||
├── INDEX.md # 本索引
|
||
├── learning/ # 早期学习笔记（可能过时）
|
||
├── analysis/ # 早期代码/问题分析
|
||
├── reports/ # 历史修复/验证报告
|
||
└── guides/ # 操作指南
|
||
|
||
mvp/ # 现行 MVP 文档（主入口）
|
||
├── architecture/ # 现行架构：系统现在怎么跑
|
||
├── engineering/ # 工程纪要：问题 / 决策 / E2E
|
||
├── issues/ # 未完成事项
|
||
├── tables/ # 表结构
|
||
├── demo/ # Demo
|
||
└── eval/ # 诊断评测材料
|
||
```
|
||
|
||
**现行架构、工程纪要、表结构、Issue 均以 [mvp/README.md](../mvp/README.md) 为准。**
|
||
本目录 `learning/` / `analysis/` / `reports/` 偏早期学习与历史记录，**可能与当前实现不一致**。
|
||
|
||
---
|
||
|
||
## 快速导航
|
||
|
||
### 我是开发者（优先）
|
||
|
||
1. [mvp/README.md](../mvp/README.md) — MVP 总入口
|
||
2. [mvp/architecture/](../mvp/architecture/) — 现行架构
|
||
3. [mvp/engineering/](../mvp/engineering/) — 工程纪要（RAG / 诊断 E2E）
|
||
4. [mvp/issues/](../mvp/issues/) — 活跃 Issue
|
||
|
||
### RAG 工程纪要（已迁入 mvp）
|
||
|
||
1. [RAG 排序：多路召回与 RRF](../mvp/engineering/rag/RAG排序-多路召回与RRF.md)
|
||
2. [Hybrid 之后的 qualityScore 与后处理](../mvp/engineering/rag/RAG-Hybrid质量分与后处理.md)
|
||
3. [Agent 如何读 relevance_level](../mvp/engineering/rag/RAG-Agent如何读relevance_level.md)
|
||
4. [RAG 离线评测：基线设计](../mvp/engineering/rag/RAG离线评测-基线设计.md)
|
||
5. [Milvus hybrid 接入清单](../mvp/engineering/rag/Milvus-Hybrid接入清单.md)
|
||
6. [RAG 审计补丁 E2E](../mvp/engineering/rag/RAG审计补丁-stepid-query-E2E验收.md)
|
||
7. 架构对照：[RAG 知识检索架构](../mvp/architecture/RAG知识检索架构.md)、[RAG 检索可观测性与审计](../mvp/architecture/RAG检索可观测性与审计.md)
|
||
|
||
### 诊断全流程（已迁入 mvp）
|
||
|
||
1. [一次诊断到底发生了什么](../mvp/engineering/diagnosis/一次诊断全流程-E2E导读.md)
|
||
|
||
### 我是新人 / 想看早期学习笔记
|
||
|
||
1. [项目学习路径](learning/00-项目学习路径.md)
|
||
2. [learning/README.md](learning/README.md)
|
||
3. 注意：内容可能过时，实现以 `mvp/architecture` 为准
|
||
|
||
### 分析 / 历史报告 / 指南
|
||
|
||
- [analysis/](analysis/) — 早期分析
|
||
- [reports/](reports/) — 历史修复与验证报告
|
||
- [guides/日志配置与分析指南.md](guides/日志配置与分析指南.md)
|
||
|
||
---
|
||
|
||
## 文档维护
|
||
|
||
| 类型 | 位置 |
|
||
|---|---|
|
||
| 现行架构 | `mvp/architecture/` |
|
||
| 工程纪要（问题/决策/E2E） | `mvp/engineering/` |
|
||
| Issue | `mvp/issues/` |
|
||
| 表结构 | `mvp/tables/` |
|
||
| 早期学习 | `docs/learning/`（归档向，不充当现行规范） |
|
||
| 操作指南 | `docs/guides/` |
|