项目文档索引

最后更新: 2026-02-09 目的: 提供项目文档的快速导航

📚 文档结构

docs/
├── CHANGELOG.md                           # 变更日志
├── README.md                              # 本文档（索引）
├── 项目架构分析/
│   ├── 项目技术栈详解.md                  # 技术栈和版本信息
│   └── 目录结构分析.md                    # 目录结构和文件组织
├── 功能模块分析/
│   ├── 地图集成分析.md                    # 高德地图集成
│   ├── 音频系统分析.md                    # 音频播放系统
│   ├── VR全景分析.md                      # 360° 全景查看器
│   └── 打卡系统分析.md                    # 打卡功能实现
├── 注意事项与陷阱/
│   └── 已知问题汇总.md                    # 已知问题和解决方案
└── 开发指南/
    ├── 新手入门指南.md                    # 快速上手
    └── 常见开发任务.md                    # 常见任务实现

🚀 快速开始

新手必读

1. 新手入门指南 - 快速上手项目
2. 项目技术栈详解 - 了解技术栈
3. 已知问题汇总 - 避免常见问题

核心功能

1. 地图集成分析 - 地图功能
2. 音频系统分析 - 音频播放
3. VR全景分析 - 全景查看器
4. 打卡系统分析 - 打卡功能

开发参考

1. 常见开发任务 - 任务实现指南
2. 目录结构分析 - 文件组织

问题排查

1. 已知问题汇总 - 问题解决方案
2. CHANGELOG - 变更历史

📖 文档阅读顺序

第一次接触项目

1. 新手入门指南
2. 项目技术栈详解
3. 目录结构分析
4. 已知问题汇总

开发新功能

1. 常见开发任务
2. 对应的功能模块分析
3. 已知问题汇总（避免重复踩坑）

问题排查

1. 已知问题汇总
2. 对应的功能模块分析
3. 技术栈详解（版本兼容性）

🔍 文档搜索

查找功能文档

# 搜索功能关键词
grep -r "地图" docs/
grep -r "音频" docs/
grep -r "打卡" docs/
grep -r "VR" docs/

查找问题解决方案

# 搜索问题关键词
grep -r "问题" docs/
grep -r "错误" docs/
grep -r "注意事项" docs/

📝 文档更新日志

2026-02-09

新增:

• 创建完整的 docs/ 目录结构
• 添加 10 份核心文档
• 涵盖技术栈、架构、功能、问题、开发指南

详细内容:

• CHANGELOG

🤝 贡献指南

更新文档

当你修改了项目或发现了新问题时，请更新相关文档：

1. 新增功能: 更新对应的功能模块分析文档
2. 修复 Bug: 更新已知问题汇总文档
3. 新增依赖: 更新技术栈详解文档
4. 结构变更: 更新目录结构分析文档
5. 任务完成: 更新 CHANGELOG.md

文档规范

• 使用中文编写文档标题和内容
• 使用清晰的章节和子章节结构
• 添加代码示例和使用说明
• 标注更新日期和作者

🔗 相关资源

项目文档

• CLAUDE.md - Claude Code 项目指南
• README.md - 项目说明

外部资源

• Vue 3 文档
• Vant 文档
• Element Plus 文档
• 高德地图文档
• Pinia 文档
• Vue Router 文档

📮 反馈

如果你发现文档有错误或需要补充的内容，请：

1. 提交 Issue
2. 提交 Pull Request
3. 联系维护者

---

最后更新: 2026-02-09 维护者: 项目团队