📚 文档目录导航

本目录包含项目的所有文档，按功能分类组织。

📁 目录结构

docs/
├── CHANGELOG.md               # 项目变更日志（核心文档）
├── README.md                  # 本文件（文档导航索引）
├── lessons-learned.md         # 经验教训总结（核心文档）
│
├── guides/                    # 📘 使用指南和教程
│   ├── 新人入门指南.md                   # 新人入门指南
│   ├── API 使用示例.md                   # API 使用示例
│   ├── API 差异指南.md                   # API 差异指南
│   ├── GET vs POST 指南.md               # GET vs POST 指南
│   ├── OpenAPI 转 API 指南.md             # OpenAPI 转 API 指南
│   ├── JSDoc 生成指南.md                  # JSDoc 生成指南
│   ├── SessionID 管理指南.md              # SessionID 管理指南
│   ├── 认证调试指南.md                   # 认证调试指南
│   ├── Taro 开发速查表.md                 # Taro 开发速查表
│   ├── Apifox 集成指南.md                 # Apifox 集成指南
│   ├── CHANGELOG 检查指南.md              # CHANGELOG 检查指南
│   └── 腾讯元宝 AI 接入说明.md             # 腾讯元宝 AI 接入说明
│
├── reports/                   # 📊 问题修复与实施报告
│   ├── 实施总结.md                       # 实施总结
│   ├── 完成报告.md                       # 完成报告
│   ├── 最终修复报告.md                   # 最终修复报告
│   ├── GET-POST 修复报告.md               # GET/POST 修复
│   ├── 重命名测试报告.md                 # 重命名测试报告
│   ├── Apifox 设置总结.md                 # Apifox 设置总结
│   ├── CHANGELOG 检查报告-2026-02-01.md  # CHANGELOG 检查报告
│   ├── 变更总结.md                       # 变更总结
│   ├── 文档图标更新.md                   # 文档图标更新
│   ├── 搜索修复总结.md                    # 搜索修复总结
│   └── 搜索问题分析.md                   # 搜索问题分析
│
├── api-specs/                 # 📝 API 规范文档（按模块组织）
│   ├── 数据文档/                        # Mock 数据文档
│   ├── user/                            # 用户模块接口
│   ├── file/                            # 文件模块接口
│   ├── get_product/                     # 产品模块接口
│   ├── news/                            # 新闻模块接口
│   ├── wechat/                          # 微信模块接口
│   ├── event/                           # 事件模块接口
│   ├── favorite/                        # 收藏模块接口
│   └── feedback/                        # 反馈模块接口
│
├── api-docs/                  # 📘 API 相关文档
│   ├── API 集成日志.md                   # API 联调日志
│   └── API 集成日志模板.md               # API 联调日志模板
│
├── decisions/                 # 📋 技术决策记录
│   └── decisions.md
│
├── plan/                      # 📋 开发计划
│   ├── 项目开发计划.md
│   ├── 前端开发计划.md
│   └── 前端开发计划-调整版.md
│
├── design/                    # 🎨 UI/UX 设计文档
│   └── manulife-V1/
│       ├── done/              # 已完成的设计稿
│       └── 录入计划书/        # 计划书设计稿
│
├── features/                  # ⭐ 功能文档
│   └── feedback-system/
│
├── specs/                    # 📄 规范文档
│
├── mcp/                      # 🤖 MCP 相关文档
│   ├── MCP_配置测试指南.md
│   └── 如何切换到独立Apifox项目.md
│
└── PreDocs/                  # 📂 前期项目文档
    └── 臻奇智荟圈小程序项目需求20260123a.docx

🚀 快速导航

核心文档

• 📖 项目变更日志 - 所有功能、修复和优化的记录
• 📖 经验教训总结 - 开发中的最佳实践和常见陷阱
• 📖 API 联调日志 - 接口联调状态记录

新手入门

👉 guides/新人入门指南.md - 快速了解业务与页面结构

开发指南

• 📘 Taro 开发速查表 - Taro API 快速查阅
• 📘 OpenAPI 转 API 详细指南 - 完整功能说明
• 📘 GET vs POST 请求处理指南 - 参数处理详解
• 📘 JSDoc 注释生成指南 - 注释生成规则
• 📘 API 使用示例 - 实际使用案例
• 📘 SessionID 管理指南 - 认证会话管理
• 📘 认证调试指南 - 授权流程调试

技术文档

• 📊 技术实现总结 - 实现细节
• 📊 功能完成报告 - 完成情况
• 📊 修复完成报告 - 问题修复

设计文档

• 🎨 UI/UX 设计稿 - 各页面设计稿

业务规划

• 📋 项目开发计划 - 业务规划与功能范围

📖 文档分类说明

📘 guides/ - 使用指南

包含面向开发者的教程和指南文档：

• 新人入门指南
• Taro 开发速查
• API 使用指南
• 认证流程调试
• 工具使用说明

📊 reports/ - 技术报告

记录开发过程中的问题修复和实施总结：

• 实现总结
• 完成报告
• 修复说明
• 测试报告

📝 api-specs/ - API 规范文档

OpenAPI 规范的 Markdown 文档和联调日志模板：

• 各模块接口定义
• 联调日志模板

🎨 design/ - 设计文档

UI/UX 设计稿和生成的代码：

• 已完成的设计稿
• 计划书设计稿

📋 decisions/ - 技术决策

记录项目中的重要技术决策和设计权衡。

📋 plan/ - 开发计划

存放各种开发计划文档。

🎯 使用建议

如果你是新开发者

1. 先看 guides/新人入门指南.md
2. 阅读 lessons-learned.md 了解经验教训
3. 查看 Taro 开发速查表.md 快速查阅 API

如果你想了解实现

1. 查看 reports/实施总结.md
2. 阅读 reports/最终修复报告.md
3. 浏览 CHANGELOG.md 了解历史变更

如果你想生成 API

1. 在 api-specs/ 目录下创建文档
2. 参考 api-docs/API 集成日志模板.md 记录联调日志
3. 运行 pnpm api:generate

如果你需要调试认证

1. 阅读 guides/认证调试指南.md
2. 参考 guides/SessionID 管理指南.md

📝 维护说明

添加新指南

放到 guides/ 目录，并在本 README 中添加说明。

添加新报告

放到 reports/ 目录，并在本 README 中添加说明。

更新日志

• 项目级别的更新：修改 CHANGELOG.md
• API 联调记录：修改 api-specs/API 集成日志.md

---

最后更新: 2026-02-14