DOCUMENTATION_INDEX.md 4.88 KB
Edit Raw Blame History


文档索引
本文档列出了搜索引擎项目的所有文档，帮助你快速找到需要的信息。


📚 快速导航
🚀 快速开始

QUICKSTART.md - 快速入门指南
USER_GUIDE.md - 用户使用指南

📖 API 文档（v3.0）

<strong>API_DOCUMENTATION.md</strong> - 完整的 API 接口文档 ⭐
API_EXAMPLES.md - API 使用示例
MIGRATION_GUIDE_V3.md - v3.0 迁移指南

🏗️ 架构设计

HighLevelDesign.md - 高层架构设计
商品数据源入ES配置规范.md - ES 配置规范
阿里opensearch电商行业.md - 行业参考

🔧 开发文档

CLAUDE.md - 项目概述（给 AI 的指南）
README.md - 项目README
DEPLOYMENT.md - 部署指南

📝 变更记录

<strong>CHANGES.md</strong> - 变更日志 ⭐
REFACTORING_SUMMARY.md - v3.0 重构总结
当前开发进度.md - 开发进度追踪

🎨 前端文档

FRONTEND_GUIDE.md - 前端指南
FRONTEND_UPDATE_V3.1.md - 前端更新记录
frontend/README.md - 前端 README

🌐 多语言支持

MULTILANG_FEATURE.md - 多语言功能
支持多语言查询.md - 多语言查询说明


📋 按主题分类
API 使用
如果你想了解如何使用 API，按以下顺序阅读：


API_DOCUMENTATION.md - 了解所有接口
API_EXAMPLES.md - 查看使用示例
USER_GUIDE.md - 完整使用指南

迁移升级
如果你需要从旧版本迁移，阅读：


MIGRATION_GUIDE_V3.md - 迁移步骤
CHANGES.md - 了解所有变更
REFACTORING_SUMMARY.md - 重构细节

系统架构
如果你想了解系统设计，阅读：


HighLevelDesign.md - 架构概览
CLAUDE.md - 项目概述
商品数据源入ES配置规范.md - 配置规范

开发部署
如果你要部署或开发，阅读：


QUICKSTART.md - 快速启动
DEPLOYMENT.md - 部署指南
USER_GUIDE.md - 详细使用说明


🆕 v3.0 新增文档
以下是 v3.0 重构时新增的文档：


文档
大小
描述
重要性


API_DOCUMENTATION.md
22 KB
完整 API 文档
⭐⭐⭐


API_EXAMPLES.md
23 KB
代码示例
⭐⭐⭐


MIGRATION_GUIDE_V3.md
9 KB
迁移指南
⭐⭐


REFACTORING_SUMMARY.md
8 KB
重构总结
⭐⭐


test_new_api.py
9 KB
测试脚本
⭐


verify_refactoring.py
7 KB
验证脚本
⭐


📊 文档统计
文档数量

总文档数：25+
Markdown 文档：19
Python 脚本：6+

文档大小

API 相关：~60 KB
架构设计：~30 KB
用户指南：~25 KB
开发文档：~20 KB


🔍 快速查找
我想...

了解如何使用 API → API_DOCUMENTATION.md
查看代码示例 → API_EXAMPLES.md
从旧版本迁移 → MIGRATION_GUIDE_V3.md
了解新功能 → CHANGES.md
快速启动系统 → QUICKSTART.md
部署到生产 → DEPLOYMENT.md
了解架构设计 → HighLevelDesign.md
配置客户 → 商品数据源入ES配置规范.md
了解多语言 → MULTILANG_FEATURE.md
前端开发 → FRONTEND_GUIDE.md


💡 推荐阅读路径
新用户

README.md - 了解项目
QUICKSTART.md - 快速启动
API_DOCUMENTATION.md - 学习 API
API_EXAMPLES.md - 查看示例

集成开发者

API_DOCUMENTATION.md - API 参考
API_EXAMPLES.md - 代码示例
USER_GUIDE.md - 使用指南
在线文档（http://localhost:6002/docs）

从旧版本升级

CHANGES.md - 了解变更
MIGRATION_GUIDE_V3.md - 迁移指南
REFACTORING_SUMMARY.md - 重构细节
test_new_api.py - 测试新功能

系统管理员

DEPLOYMENT.md - 部署指南
USER_GUIDE.md - 使用指南
README.md - 系统概述


📞 获取帮助
在线资源

Swagger UI: http://localhost:6002/docs
ReDoc: http://localhost:6002/redoc
健康检查: http://localhost:6002/admin/health

测试脚本
# 验证重构
python3 verify_refactoring.py

# 测试 API
python3 test_new_api.py


最后更新: 2024-11-12

版本: 3.0