Hooke / manulife-weapp

Go to a project
Toggle navigation Toggle navigation pinning
hookehuyr
fc100dd6 1 parent b5592541

docs: 重构文档目录结构，提升组织清晰度 

删除重复文件：
- DOCS_STRUCTURE.md（与 README.md 内容重复）

文档归类优化：
- auth-debug-guide.md → guides/auth-debug-guide.md（认证调试指南）
- TARO_QUICK_REFERENCE.md → guides/TARO_QUICK_REFERENCE.md（Taro 速查表）
- api-integration-log-template.md → api-specs/api-integration-log-template.md（API 联调模板）

更新文档：
- README.md：更新目录结构说明，添加新归类文档的导航

收益：
- 文档结构更清晰，按功能分类组织
- 减少顶层文件数量，保留核心文档
- 便于开发者快速查找所需文档

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Inline Side-by-side
Showing 5 changed files with 107 additions and 155 deletions
1 -# Docs 目录结构说明
2 -
3 -## 📁 目录结构
4 -
5 -```
6 -docs/
7 -├── README.md # 文档总索引（保留在顶层）
8 -├── CHANGELOG.md # 变更日志（保留在顶层）
9 -├── lessons-learned.md # 经验教训总结（保留在顶层）
10 -│
11 -├── PreDocs/ # 前期项目文档
12 -│ └── 臻奇智荟圈小程序项目需求20260123a.docx
13 -│
14 -├── decisions/ # 技术决策记录
15 -│ └── decisions.md
16 -│
17 -├── plan/ # 开发计划
18 -│ ├── 项目开发计划.md
19 -│ ├── 前端开发计划.md
20 -│ └── 前端开发计划-调整版.md
21 -│
22 -├── guides/ # 指南文档
23 -│ ├── START_HERE.md # 新人入门指南
24 -│ ├── API_USAGE_EXAMPLES.md # API 使用示例
25 -│ ├── API_DIFF_GUIDE.md # API 差异指南
26 -│ ├── GET_VS_POST_GUIDE.md # GET vs POST 指南
27 -│ ├── OPENAPI_TO_API_GUIDE.md # OpenAPI 转 API 指南
28 -│ ├── JSDOC_GENERATION_GUIDE.md # JSDoc 生成指南
29 -│ ├── apifox-integration-guide.md # Apifox 集成指南
30 -│ ├── changelog-check-guide.md # CHANGELOG 检查指南
31 -│ └── 腾讯元宝AI接入说明.md # 腾讯元宝 AI 接入说明
32 -│
33 -├── reports/ # 问题修复与实施报告
34 -│ ├── COMPLETION_REPORT.md # 完成报告
35 -│ ├── FINAL_FIX_REPORT.md # 最终修复报告
36 -│ ├── IMPLEMENTATION_SUMMARY.md # 实施总结
37 -│ ├── GET_POST_FIX.md # GET/POST 修复
38 -│ ├── RENAME_TEST_REPORT.md # 重命名测试报告
39 -│ ├── apifox-setup-summary.md # Apifox 设置总结
40 -│ ├── changelog-check-report-20260201.md # CHANGELOG 检查报告
41 -│ ├── changes-summary.md # 变更总结
42 -│ ├── DOCUMENT_ICONS_UPDATE.md # 文档图标更新
43 -│ ├── search-fix-summary.md # 搜索修复总结
44 -│ └── search-problems-analysis.md # 搜索问题分析
45 -│
46 -├── design/ # UI/UX 设计文档
47 -│ └── manulife-V1/
48 -│ ├── done/ # 已完成的设计稿
49 -│ │ ├── 首页/
50 -│ │ ├── 入职相关/
51 -│ │ ├── 签单相关/
52 -│ │ ├── 资料知识库/
53 -│ │ ├── 资料列表/
54 -│ │ ├── 产品详情/
55 -│ │ ├── 计划书/
56 -│ │ ├── 我的/
57 -│ │ ├── 我的收藏/
58 -│ │ ├── 修改头像/
59 -│ │ ├── 意见反馈/
60 -│ │ └── 帮助中心/
61 -│ └── 录入计划书/
62 -│ ├── 方案A/
63 -│ └── 方案B/
64 -│
65 -└── mcp/ # MCP 相关文档
66 - ├── MCP_配置测试指南.md
67 - └── 如何切换到独立Apifox项目.md
68 -```
69 -
70 -## 📝 文档说明
71 -
72 -### 顶层文档（核心文档）
73 -
74 -| 文件 | 说明 |
75 -|------|------|
76 -| `README.md` | 文档总索引，快速了解项目文档结构 |
77 -| `CHANGELOG.md` | 项目变更日志，记录所有功能、修复和优化 |
78 -| `lessons-learned.md` | 开发经验教训，包含最佳实践和常见陷阱 |
79 -
80 -### decisions/ - 技术决策记录
81 -
82 -记录项目中的重要技术决策和设计权衡。
83 -
84 -### plan/ - 开发计划
85 -
86 -存放各种开发计划文档，包括整体计划和调整版计划。
87 -
88 -### guides/ - 指南文档
89 -
90 -开发过程中使用的各种指南文档，帮助开发者快速上手。
91 -
92 -### reports/ - 问题修复与实施报告
93 -
94 -记录问题修复过程、实施总结和测试报告。
95 -
96 -### design/ - UI/UX 设计文档
97 -
98 -存放 UI/UX 设计稿和生成的代码。
99 -
100 -### mcp/ - MCP 相关文档
101 -
102 -MCP (Model Context Protocol) 相关配置和测试指南。
103 -
104 -## 🔍 快速查找
105 -
106 -- **我是新开发者，想快速上手** → 阅读 `guides/START_HERE.md`
107 -- **我想了解项目的历史变更** → 查看 `CHANGELOG.md`
108 -- **我遇到了开发问题** → 查看 `lessons-learned.md` 和 `reports/`
109 -- **我需要添加新功能** → 先查看 `decisions/` 了解技术决策
110 -- **我需要修改 UI** → 查看 `design/` 中的设计稿
111 -
112 ----
113 -
114 -**整理日期**: 2026-02-02
...@@ -6,86 +6,152 @@ ...@@ -6,86 +6,152 @@
6 6
7 ``` 7 ```
8 docs/ 8 docs/
9 -├── CHANGELOG.md # 项目更新日志（保持不变） 9 +├── CHANGELOG.md # 项目变更日志（核心文档）
10 -├── README.md # 本文件 10 +├── README.md # 本文件（文档导航索引）
11 +├── lessons-learned.md # 经验教训总结（核心文档）
12 +├── api-integration-log.md # API 联调日志
11 │ 13 │
12 ├── guides/ # 📘 使用指南和教程 14 ├── guides/ # 📘 使用指南和教程
13 -│ ├── START_HERE.md # 从这里开始 15 +│ ├── START_HERE.md # 新人入门指南
14 -│ ├── OPENAPI_TO_API_GUIDE.md # OpenAPI 转 API 详细指南 16 +│ ├── API_USAGE_EXAMPLES.md # API 使用示例
15 -│ ├── GET_VS_POST_GUIDE.md # GET vs POST 请求处理指南 17 +│ ├── API_DIFF_GUIDE.md # API 差异指南
16 -│ ├── JSDOC_GENERATION_GUIDE.md # JSDoc 注释生成指南 18 +│ ├── GET_VS_POST_GUIDE.md # GET vs POST 指南
17 -│ └── API_USAGE_EXAMPLES.md # API 使用示例 19 +│ ├── OPENAPI_TO_API_GUIDE.md # OpenAPI 转 API 指南
20 +│ ├── JSDOC_GENERATION_GUIDE.md # JSDoc 生成指南
21 +│ ├── SESSIONID_MANAGEMENT.md # SessionID 管理指南
22 +│ ├── auth-debug-guide.md # 认证调试指南
23 +│ ├── TARO_QUICK_REFERENCE.md # Taro 开发速查表
24 +│ ├── apifox-integration-guide.md # Apifox 集成指南
25 +│ ├── changelog-check-guide.md # CHANGELOG 检查指南
26 +│ └── 腾讯元宝AI接入说明.md # 腾讯元宝 AI 接入说明
18 │ 27 │
19 -├── reports/ # 📊 实现报告和文档 28 +├── reports/ # 📊 问题修复与实施报告
20 -│ ├── IMPLEMENTATION_SUMMARY.md # 技术实现总结 29 +│ ├── IMPLEMENTATION_SUMMARY.md # 实施总结
21 -│ ├── COMPLETION_REPORT.md # 功能完成报告 30 +│ ├── COMPLETION_REPORT.md # 完成报告
22 -│ ├── FINAL_FIX_REPORT.md # 修复完成报告 31 +│ ├── FINAL_FIX_REPORT.md # 最终修复报告
23 -│ ├── GET_POST_FIX.md # 修复说明文档 32 +│ ├── GET_POST_FIX.md # GET/POST 修复
24 -│ └── UPDATE_LOG.md # 功能更新日志 33 +│ ├── RENAME_TEST_REPORT.md # 重命名测试报告
34 +│ ├── apifox-setup-summary.md # Apifox 设置总结
35 +│ ├── changelog-check-report-20260201.md # CHANGELOG 检查报告
36 +│ ├── changes-summary.md # 变更总结
37 +│ ├── DOCUMENT_ICONS_UPDATE.md # 文档图标更新
38 +│ ├── search-fix-summary.md # 搜索修复总结
39 +│ └── search-problems-analysis.md # 搜索问题分析
25 │ 40 │
26 -├── api-specs/ # 📝 API 规范文档源文件 41 +├── api-specs/ # 📝 API 规范文档
27 -│ ├── user/ # 用户模块 42 +│ ├── api-integration-log-template.md # API 联调日志模板
28 -│ └── order/ # 订单模块 43 +│ ├── user/ # 用户模块接口
44 +│ ├── file/ # 文件模块接口
45 +│ ├── get_product/ # 产品模块接口
46 +│ ├── news/ # 新闻模块接口
47 +│ └── wechat/ # 微信模块接口
29 │ 48 │
30 -├── Design/ # 🎨 设计文档 49 +├── decisions/ # 📋 技术决策记录
31 -├── PLAN/ # 📋 项目计划 50 +│ └── decisions.md
32 -├── PreDocs/ # 📄 预留文档 51 +│
33 -└── TODO/ # ✅ 待办事项 52 +├── plan/ # 📋 开发计划
53 +│ ├── 项目开发计划.md
54 +│ ├── 前端开发计划.md
55 +│ └── 前端开发计划-调整版.md
56 +│
57 +├── design/ # 🎨 UI/UX 设计文档
58 +│ └── manulife-V1/
59 +│ ├── done/ # 已完成的设计稿
60 +│ └── 录入计划书/ # 计划书设计稿
61 +│
62 +├── features/ # ⭐ 功能文档
63 +│ └── feedback-system/
64 +│
65 +├── specs/ # 📄 规范文档
66 +│
67 +├── mcp/ # 🤖 MCP 相关文档
68 +│ ├── MCP_配置测试指南.md
69 +│ └── 如何切换到独立Apifox项目.md
70 +│
71 +└── PreDocs/ # 📂 前期项目文档
72 + └── 臻奇智荟圈小程序项目需求20260123a.docx
34 ``` 73 ```
35 74
36 ## 🚀 快速导航 75 ## 🚀 快速导航
37 76
77 +### 核心文档
78 +- 📖 [项目变更日志](CHANGELOG.md) - 所有功能、修复和优化的记录
79 +- 📖 [经验教训总结](lessons-learned.md) - 开发中的最佳实践和常见陷阱
80 +- 📖 [API 联调日志](api-integration-log.md) - 接口联调状态记录
81 +
38 ### 新手入门 82 ### 新手入门
39 👉 **[guides/START_HERE.md](guides/START_HERE.md)** - 快速了解项目功能 83 👉 **[guides/START_HERE.md](guides/START_HERE.md)** - 快速了解项目功能
40 84
41 -### 使用指南 85 +### 开发指南
86 +- 📘 [Taro 开发速查表](guides/TARO_QUICK_REFERENCE.md) - Taro API 快速查阅
42 - 📘 [OpenAPI 转 API 详细指南](guides/OPENAPI_TO_API_GUIDE.md) - 完整功能说明 87 - 📘 [OpenAPI 转 API 详细指南](guides/OPENAPI_TO_API_GUIDE.md) - 完整功能说明
43 - 📘 [GET vs POST 请求处理指南](guides/GET_VS_POST_GUIDE.md) - 参数处理详解 88 - 📘 [GET vs POST 请求处理指南](guides/GET_VS_POST_GUIDE.md) - 参数处理详解
44 - 📘 [JSDoc 注释生成指南](guides/JSDOC_GENERATION_GUIDE.md) - 注释生成规则 89 - 📘 [JSDoc 注释生成指南](guides/JSDOC_GENERATION_GUIDE.md) - 注释生成规则
45 - 📘 [API 使用示例](guides/API_USAGE_EXAMPLES.md) - 实际使用案例 90 - 📘 [API 使用示例](guides/API_USAGE_EXAMPLES.md) - 实际使用案例
91 +- 📘 [SessionID 管理指南](guides/SESSIONID_MANAGEMENT.md) - 认证会话管理
92 +- 📘 [认证调试指南](guides/auth-debug-guide.md) - 授权流程调试
46 93
47 ### 技术文档 94 ### 技术文档
48 - 📊 [技术实现总结](reports/IMPLEMENTATION_SUMMARY.md) - 实现细节 95 - 📊 [技术实现总结](reports/IMPLEMENTATION_SUMMARY.md) - 实现细节
49 - 📊 [功能完成报告](reports/COMPLETION_REPORT.md) - 完成情况 96 - 📊 [功能完成报告](reports/COMPLETION_REPORT.md) - 完成情况
50 - 📊 [修复完成报告](reports/FINAL_FIX_REPORT.md) - 问题修复 97 - 📊 [修复完成报告](reports/FINAL_FIX_REPORT.md) - 问题修复
51 -- 📊 [功能更新日志](reports/UPDATE_LOG.md) - 版本更新 98 +
99 +### 设计文档
100 +- 🎨 [UI/UX 设计稿](design/manulife-V1/done/) - 各页面设计稿
52 101
53 ## 📖 文档分类说明 102 ## 📖 文档分类说明
54 103
55 ### 📘 guides/ - 使用指南 104 ### 📘 guides/ - 使用指南
56 -包含面向用户的使用教程和指南文档： 105 +包含面向开发者的教程和指南文档：
57 -- 快速开始指南 106 +- 新人入门指南
58 -- 功能详细说明 107 +- Taro 开发速查
59 -- 参数处理规则 108 +- API 使用指南
60 -- 代码使用示例 109 +- 认证流程调试
110 +- 工具使用说明
61 111
62 ### 📊 reports/ - 技术报告 112 ### 📊 reports/ - 技术报告
63 -包含面向开发者的技术实现文档： 113 +记录开发过程中的问题修复和实施总结：
64 - 实现总结 114 - 实现总结
65 - 完成报告 115 - 完成报告
66 - 修复说明 116 - 修复说明
67 -- 更新日志 117 +- 测试报告
118 +
119 +### 📝 api-specs/ - API 规范文档
120 +OpenAPI 规范的 Markdown 文档和联调日志模板：
121 +- 各模块接口定义
122 +- 联调日志模板
68 123
69 -### 📝 api-specs/ - API 规范文档源文件 124 +### 🎨 design/ - 设计文档
70 -OpenAPI 规范的 Markdown 文档，用于生成 API 代码： 125 +UI/UX 设计稿和生成的代码：
71 -- user/ - 用户模块接口 126 +- 已完成的设计稿
72 -- order/ - 订单模块接口 127 +- 计划书设计稿
128 +
129 +### 📋 decisions/ - 技术决策
130 +记录项目中的重要技术决策和设计权衡。
131 +
132 +### 📋 plan/ - 开发计划
133 +存放各种开发计划文档。
73 134
74 ## 🎯 使用建议 135 ## 🎯 使用建议
75 136
76 -### 如果你是新手 137 +### 如果你是新开发者
77 1. 先看 [guides/START_HERE.md](guides/START_HERE.md) 138 1. 先看 [guides/START_HERE.md](guides/START_HERE.md)
78 -2. 阅读 [guides/OPENAPI_TO_API_GUIDE.md](guides/OPENAPI_TO_API_GUIDE.md) 139 +2. 阅读 [lessons-learned.md](lessons-learned.md) 了解经验教训
79 -3. 参考 [guides/API_USAGE_EXAMPLES.md](guides/API_USAGE_EXAMPLES.md) 140 +3. 查看 [TARO_QUICK_REFERENCE.md](guides/TARO_QUICK_REFERENCE.md) 快速查阅 API
80 141
81 ### 如果你想了解实现 142 ### 如果你想了解实现
82 1. 查看 [reports/IMPLEMENTATION_SUMMARY.md](reports/IMPLEMENTATION_SUMMARY.md) 143 1. 查看 [reports/IMPLEMENTATION_SUMMARY.md](reports/IMPLEMENTATION_SUMMARY.md)
83 2. 阅读 [reports/FINAL_FIX_REPORT.md](reports/FINAL_FIX_REPORT.md) 144 2. 阅读 [reports/FINAL_FIX_REPORT.md](reports/FINAL_FIX_REPORT.md)
145 +3. 浏览 [CHANGELOG.md](CHANGELOG.md) 了解历史变更
84 146
85 ### 如果你想生成 API 147 ### 如果你想生成 API
86 1. 在 `api-specs/` 目录下创建文档 148 1. 在 `api-specs/` 目录下创建文档
87 -2. 运行 `pnpm api:generate` 149 +2. 参考 [api-integration-log-template.md](api-specs/api-integration-log-template.md) 记录联调日志
88 -3. 查看生成的文件 150 +3. 运行 `pnpm api:generate`
151 +
152 +### 如果你需要调试认证
153 +1. 阅读 [guides/auth-debug-guide.md](guides/auth-debug-guide.md)
154 +2. 参考 [guides/SESSIONID_MANAGEMENT.md](guides/SESSIONID_MANAGEMENT.md)
89 155
90 ## 📝 维护说明 156 ## 📝 维护说明
91 157
...@@ -96,9 +162,9 @@ OpenAPI 规范的 Markdown 文档，用于生成 API 代码： ...@@ -96,9 +162,9 @@ OpenAPI 规范的 Markdown 文档，用于生成 API 代码：
96 放到 `reports/` 目录，并在本 README 中添加说明。 162 放到 `reports/` 目录，并在本 README 中添加说明。
97 163
98 ### 更新日志 164 ### 更新日志
99 -- 项目级别的更新：修改根目录的 `CHANGELOG.md` 165 +- 项目级别的更新：修改 `CHANGELOG.md`
100 -- 功能级别的更新：修改 `reports/UPDATE_LOG.md` 166 +- API 联调记录：修改 `api-integration-log.md`
101 167
102 --- 168 ---
103 169
104 -**最后更新**: 2026-01-27 170 +**最后更新**: 2026-02-05
......