**变更概述:** - 将 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/(问题分析和重构计划)
3.8 KiB
3.8 KiB
文档索引
📂 目录结构
docs/
├── README.md # 项目文档总览
├── INDEX.md # 本索引文件
│
├── learning/ # 📚 学习笔记(个人学习理解)
│ ├── 00-项目学习路径.md
│ ├── 01~08-*.md # 按学习顺序编号
│ └── README.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 架构、数据库设计、实施计划等。
🚀 快速导航
我是新人/学习者
- 项目学习路径 - 从这里开始
- learning/README.md - 学习笔记索引
- 按编号顺序阅读
learning/目录下的文档
我是开发者
👉 MVP 架构设计文档已移至 ../mvp/
请查看 mvp/README.md 了解:
- MVP 架构设计
- 数据库设计和表结构
- 实施规划(Phase 1/2/3)
- 会话管理设计
我要查看分析报告
📚 学习笔记 (learning/)
按学习顺序编号,建议按顺序阅读:
- 00-项目学习路径
- 01-AI-Ops-核心设计-Essence报告
- 02-outputKey-深度解析
- 03-核心疑问解答
- 04-RAG-分块策略-Essence报告
- 05-文件上传自动索引-Essence报告
- 06-RAG查询流程-Essence报告
- 07-Tool定义方式对比与优化
- 08-MethodToolCallback-vs-ToolCallingManager深度分析
🔍 分析笔记 (analysis/)
代码分析和问题分析文档:
- essence-report-rag.md
- essence-report-rag-chunking.md
- explore-report.md
- chunking-issues-analysis.md
- 功能分析报告.md
📝 临时报告 (reports/)
修复报告和验证报告:
📖 指南文档 (guides/)
🔄 文档维护
- 学习笔记 放在
learning/目录,按编号顺序命名 - 分析笔记 放在
analysis/目录 - 临时报告 放在
reports/目录 - 指南文档 放在
guides/目录 - MVP 架构设计 已移至项目根目录
../mvp/(包含架构、数据库、实施计划)