Docs 目录结构说明

📁 目录结构

docs/
├── README.md                  # 文档总索引（保留在顶层）
├── CHANGELOG.md               # 变更日志（保留在顶层）
├── lessons-learned.md         # 经验教训总结（保留在顶层）
│
├── PreDocs/                   # 前期项目文档
│   └── 臻奇智荟圈小程序项目需求20260123a.docx
│
├── decisions/                 # 技术决策记录
│   └── decisions.md
│
├── plan/                      # 开发计划
│   ├── 项目开发计划.md
│   ├── 前端开发计划.md
│   └── 前端开发计划-调整版.md
│
├── guides/                    # 指南文档
│   ├── START_HERE.md                          # 新人入门指南
│   ├── API_USAGE_EXAMPLES.md                  # API 使用示例
│   ├── API_DIFF_GUIDE.md                      # API 差异指南
│   ├── GET_VS_POST_GUIDE.md                   # GET vs POST 指南
│   ├── OPENAPI_TO_API_GUIDE.md                # OpenAPI 转 API 指南
│   ├── JSDOC_GENERATION_GUIDE.md              # JSDoc 生成指南
│   ├── apifox-integration-guide.md            # Apifox 集成指南
│   ├── changelog-check-guide.md               # CHANGELOG 检查指南
│   └── 腾讯元宝AI接入说明.md                    # 腾讯元宝 AI 接入说明
│
├── reports/                   # 问题修复与实施报告
│   ├── COMPLETION_REPORT.md                    # 完成报告
│   ├── FINAL_FIX_REPORT.md                    # 最终修复报告
│   ├── IMPLEMENTATION_SUMMARY.md              # 实施总结
│   ├── GET_POST_FIX.md                        # GET/POST 修复
│   ├── RENAME_TEST_REPORT.md                  # 重命名测试报告
│   ├── apifox-setup-summary.md                # Apifox 设置总结
│   ├── changelog-check-report-20260201.md     # CHANGELOG 检查报告
│   ├── changes-summary.md                     # 变更总结
│   ├── DOCUMENT_ICONS_UPDATE.md               # 文档图标更新
│   ├── search-fix-summary.md                  # 搜索修复总结
│   └── search-problems-analysis.md            # 搜索问题分析
│
├── design/                    # UI/UX 设计文档
│   └── manulife-V1/
│       ├── done/              # 已完成的设计稿
│       │   ├── 首页/
│       │   ├── 入职相关/
│       │   ├── 签单相关/
│       │   ├── 资料知识库/
│       │   ├── 资料列表/
│       │   ├── 产品详情/
│       │   ├── 计划书/
│       │   ├── 我的/
│       │   ├── 我的收藏/
│       │   ├── 修改头像/
│       │   ├── 意见反馈/
│       │   └── 帮助中心/
│       └── 录入计划书/
│           ├── 方案A/
│           └── 方案B/
│
└── mcp/                       # MCP 相关文档
    ├── MCP_配置测试指南.md
    └── 如何切换到独立Apifox项目.md

📝 文档说明

顶层文档（核心文档）

文件	说明
README.md	文档总索引，快速了解项目文档结构
CHANGELOG.md	项目变更日志，记录所有功能、修复和优化
lessons-learned.md	开发经验教训，包含最佳实践和常见陷阱

decisions/ - 技术决策记录

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

plan/ - 开发计划

存放各种开发计划文档，包括整体计划和调整版计划。

guides/ - 指南文档

开发过程中使用的各种指南文档，帮助开发者快速上手。

reports/ - 问题修复与实施报告

记录问题修复过程、实施总结和测试报告。

design/ - UI/UX 设计文档

存放 UI/UX 设计稿和生成的代码。

mcp/ - MCP 相关文档

MCP (Model Context Protocol) 相关配置和测试指南。

🔍 快速查找

• 我是新开发者，想快速上手 → 阅读 guides/START_HERE.md
• 我想了解项目的历史变更 → 查看 CHANGELOG.md
• 我遇到了开发问题 → 查看 lessons-learned.md 和 reports/
• 我需要添加新功能 → 先查看 decisions/ 了解技术决策
• 我需要修改 UI → 查看 design/ 中的设计稿

---

整理日期: 2026-02-02