hookehuyr

docs: 整理文档结构并使用中文命名

- 删除旧版英文/混合命名文档,迁移到中文文件名
- 重新组织 docs/guides/ 和 docs/reports/ 目录
- 更新 docs/README.md 以反映新结构
- 删除已废弃的 form-sn-mapping.json(配置已迁移到代码)

影响范围:
- 文档重组(guides、reports、mcp、plan 目录)
- 新增中文命名文档(API 使用指南、变更日志检查等)
- 更新文档索引和交叉引用

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Showing 30 changed files with 52 additions and 133 deletions
...@@ -302,7 +302,7 @@ console.log(product.form_sn) // 应该有值,如 "life-insurance-wiop3e" ...@@ -302,7 +302,7 @@ console.log(product.form_sn) // 应该有值,如 "life-insurance-wiop3e"
302 302
303 - [完整架构文档](./plan-entry-architecture.md) 303 - [完整架构文档](./plan-entry-architecture.md)
304 - [经验教训总结](../lessons-learned/plan-entry-module-summary.md) 304 - [经验教训总结](../lessons-learned/plan-entry-module-summary.md)
305 -- [API 联调日志](../api-specs/API 集成日志.md) 305 +- [API 联调日志](../api-docs/API 集成日志.md)
306 306
307 --- 307 ---
308 308
......
...@@ -11,39 +11,46 @@ docs/ ...@@ -11,39 +11,46 @@ docs/
11 ├── lessons-learned.md # 经验教训总结(核心文档) 11 ├── lessons-learned.md # 经验教训总结(核心文档)
12 12
13 ├── guides/ # 📘 使用指南和教程 13 ├── guides/ # 📘 使用指南和教程
14 -│ ├── START_HERE.md # 新人入门指南 14 +│ ├── 新人入门指南.md # 新人入门指南
15 -│ ├── API_USAGE_EXAMPLES.md # API 使用示例 15 +│ ├── API 使用示例.md # API 使用示例
16 -│ ├── API_DIFF_GUIDE.md # API 差异指南 16 +│ ├── API 差异指南.md # API 差异指南
17 -│ ├── GET_VS_POST_GUIDE.md # GET vs POST 指南 17 +│ ├── GET vs POST 指南.md # GET vs POST 指南
18 -│ ├── OPENAPI_TO_API_GUIDE.md # OpenAPI 转 API 指南 18 +│ ├── OpenAPI 转 API 指南.md # OpenAPI 转 API 指南
19 -│ ├── JSDOC_GENERATION_GUIDE.md # JSDoc 生成指南 19 +│ ├── JSDoc 生成指南.md # JSDoc 生成指南
20 -│ ├── SESSIONID_MANAGEMENT.md # SessionID 管理指南 20 +│ ├── SessionID 管理指南.md # SessionID 管理指南
21 -│ ├── auth-debug-guide.md # 认证调试指南 21 +│ ├── 认证调试指南.md # 认证调试指南
22 -│ ├── TARO_QUICK_REFERENCE.md # Taro 开发速查表 22 +│ ├── Taro 开发速查表.md # Taro 开发速查表
23 -│ ├── apifox-integration-guide.md # Apifox 集成指南 23 +│ ├── Apifox 集成指南.md # Apifox 集成指南
24 -│ ├── changelog-check-guide.md # CHANGELOG 检查指南 24 +│ ├── CHANGELOG 检查指南.md # CHANGELOG 检查指南
25 -│ └── 腾讯元宝AI接入说明.md # 腾讯元宝 AI 接入说明 25 +│ └── 腾讯元宝 AI 接入说明.md # 腾讯元宝 AI 接入说明
26 26
27 ├── reports/ # 📊 问题修复与实施报告 27 ├── reports/ # 📊 问题修复与实施报告
28 -│ ├── IMPLEMENTATION_SUMMARY.md # 实施总结 28 +│ ├── 实施总结.md # 实施总结
29 -│ ├── COMPLETION_REPORT.md # 完成报告 29 +│ ├── 完成报告.md # 完成报告
30 -│ ├── FINAL_FIX_REPORT.md # 最终修复报告 30 +│ ├── 最终修复报告.md # 最终修复报告
31 -│ ├── GET_POST_FIX.md # GET/POST 修复 31 +│ ├── GET-POST 修复报告.md # GET/POST 修复
32 -│ ├── RENAME_TEST_REPORT.md # 重命名测试报告 32 +│ ├── 重命名测试报告.md # 重命名测试报告
33 -│ ├── apifox-setup-summary.md # Apifox 设置总结 33 +│ ├── Apifox 设置总结.md # Apifox 设置总结
34 -│ ├── changelog-check-report-20260201.md # CHANGELOG 检查报告 34 +│ ├── CHANGELOG 检查报告-2026-02-01.md # CHANGELOG 检查报告
35 -│ ├── changes-summary.md # 变更总结 35 +│ ├── 变更总结.md # 变更总结
36 -│ ├── DOCUMENT_ICONS_UPDATE.md # 文档图标更新 36 +│ ├── 文档图标更新.md # 文档图标更新
37 -│ ├── search-fix-summary.md # 搜索修复总结 37 +│ ├── 搜索修复总结.md # 搜索修复总结
38 -│ └── search-problems-analysis.md # 搜索问题分析 38 +│ └── 搜索问题分析.md # 搜索问题分析
39 39
40 -├── api-specs/ # 📝 API 规范文档 40 +├── api-specs/ # 📝 API 规范文档(按模块组织)
41 -│ ├── api-integration-log-template.md # API 联调日志模板 41 +│ ├── 数据文档/ # Mock 数据文档
42 │ ├── user/ # 用户模块接口 42 │ ├── user/ # 用户模块接口
43 │ ├── file/ # 文件模块接口 43 │ ├── file/ # 文件模块接口
44 │ ├── get_product/ # 产品模块接口 44 │ ├── get_product/ # 产品模块接口
45 │ ├── news/ # 新闻模块接口 45 │ ├── news/ # 新闻模块接口
46 -│ └── wechat/ # 微信模块接口 46 +│ ├── wechat/ # 微信模块接口
47 +│ ├── event/ # 事件模块接口
48 +│ ├── favorite/ # 收藏模块接口
49 +│ └── feedback/ # 反馈模块接口
50 +
51 +├── api-docs/ # 📘 API 相关文档
52 +│ ├── API 集成日志.md # API 联调日志
53 +│ └── API 集成日志模板.md # API 联调日志模板
47 54
48 ├── decisions/ # 📋 技术决策记录 55 ├── decisions/ # 📋 技术决策记录
49 │ └── decisions.md 56 │ └── decisions.md
...@@ -79,21 +86,21 @@ docs/ ...@@ -79,21 +86,21 @@ docs/
79 - 📖 [API 联调日志](api-specs/API 集成日志.md) - 接口联调状态记录 86 - 📖 [API 联调日志](api-specs/API 集成日志.md) - 接口联调状态记录
80 87
81 ### 新手入门 88 ### 新手入门
82 -👉 **[guides/START_HERE.md](guides/START_HERE.md)** - 快速了解项目功能 89 +👉 **[guides/新人入门指南.md](guides/新人入门指南.md)** - 快速了解项目功能
83 90
84 ### 开发指南 91 ### 开发指南
85 -- 📘 [Taro 开发速查表](guides/TARO_QUICK_REFERENCE.md) - Taro API 快速查阅 92 +- 📘 [Taro 开发速查表](guides/Taro 开发速查表.md) - Taro API 快速查阅
86 -- 📘 [OpenAPI 转 API 详细指南](guides/OPENAPI_TO_API_GUIDE.md) - 完整功能说明 93 +- 📘 [OpenAPI 转 API 详细指南](guides/OpenAPI 转 API 指南.md) - 完整功能说明
87 -- 📘 [GET vs POST 请求处理指南](guides/GET_VS_POST_GUIDE.md) - 参数处理详解 94 +- 📘 [GET vs POST 请求处理指南](guides/GET vs POST 指南.md) - 参数处理详解
88 -- 📘 [JSDoc 注释生成指南](guides/JSDOC_GENERATION_GUIDE.md) - 注释生成规则 95 +- 📘 [JSDoc 注释生成指南](guides/JSDoc 生成指南.md) - 注释生成规则
89 -- 📘 [API 使用示例](guides/API_USAGE_EXAMPLES.md) - 实际使用案例 96 +- 📘 [API 使用示例](guides/API 使用示例.md) - 实际使用案例
90 -- 📘 [SessionID 管理指南](guides/SESSIONID_MANAGEMENT.md) - 认证会话管理 97 +- 📘 [SessionID 管理指南](guides/SessionID 管理指南.md) - 认证会话管理
91 -- 📘 [认证调试指南](guides/auth-debug-guide.md) - 授权流程调试 98 +- 📘 [认证调试指南](guides/认证调试指南.md) - 授权流程调试
92 99
93 ### 技术文档 100 ### 技术文档
94 -- 📊 [技术实现总结](reports/IMPLEMENTATION_SUMMARY.md) - 实现细节 101 +- 📊 [技术实现总结](reports/实施总结.md) - 实现细节
95 -- 📊 [功能完成报告](reports/COMPLETION_REPORT.md) - 完成情况 102 +- 📊 [功能完成报告](reports/完成报告.md) - 完成情况
96 -- 📊 [修复完成报告](reports/FINAL_FIX_REPORT.md) - 问题修复 103 +- 📊 [修复完成报告](reports/最终修复报告.md) - 问题修复
97 104
98 ### 设计文档 105 ### 设计文档
99 - 🎨 [UI/UX 设计稿](design/manulife-V1/done/) - 各页面设计稿 106 - 🎨 [UI/UX 设计稿](design/manulife-V1/done/) - 各页面设计稿
...@@ -134,23 +141,23 @@ UI/UX 设计稿和生成的代码: ...@@ -134,23 +141,23 @@ UI/UX 设计稿和生成的代码:
134 ## 🎯 使用建议 141 ## 🎯 使用建议
135 142
136 ### 如果你是新开发者 143 ### 如果你是新开发者
137 -1. 先看 [guides/START_HERE.md](guides/START_HERE.md) 144 +1. 先看 [guides/新人入门指南.md](guides/新人入门指南.md)
138 2. 阅读 [lessons-learned.md](lessons-learned.md) 了解经验教训 145 2. 阅读 [lessons-learned.md](lessons-learned.md) 了解经验教训
139 -3. 查看 [TARO_QUICK_REFERENCE.md](guides/TARO_QUICK_REFERENCE.md) 快速查阅 API 146 +3. 查看 [Taro 开发速查表.md](guides/Taro 开发速查表.md) 快速查阅 API
140 147
141 ### 如果你想了解实现 148 ### 如果你想了解实现
142 -1. 查看 [reports/IMPLEMENTATION_SUMMARY.md](reports/IMPLEMENTATION_SUMMARY.md) 149 +1. 查看 [reports/实施总结.md](reports/实施总结.md)
143 -2. 阅读 [reports/FINAL_FIX_REPORT.md](reports/FINAL_FIX_REPORT.md) 150 +2. 阅读 [reports/最终修复报告.md](reports/最终修复报告.md)
144 3. 浏览 [CHANGELOG.md](CHANGELOG.md) 了解历史变更 151 3. 浏览 [CHANGELOG.md](CHANGELOG.md) 了解历史变更
145 152
146 ### 如果你想生成 API 153 ### 如果你想生成 API
147 1.`api-specs/` 目录下创建文档 154 1.`api-specs/` 目录下创建文档
148 -2. 参考 [api-integration-log-template.md](api-specs/api-integration-log-template.md) 记录联调日志 155 +2. 参考 [api-docs/API 集成日志模板.md](api-docs/API 集成日志模板.md) 记录联调日志
149 3. 运行 `pnpm api:generate` 156 3. 运行 `pnpm api:generate`
150 157
151 ### 如果你需要调试认证 158 ### 如果你需要调试认证
152 -1. 阅读 [guides/auth-debug-guide.md](guides/auth-debug-guide.md) 159 +1. 阅读 [guides/认证调试指南.md](guides/认证调试指南.md)
153 -2. 参考 [guides/SESSIONID_MANAGEMENT.md](guides/SESSIONID_MANAGEMENT.md) 160 +2. 参考 [guides/SessionID 管理指南.md](guides/SessionID 管理指南.md)
154 161
155 ## 📝 维护说明 162 ## 📝 维护说明
156 163
......
1 -{
2 - "version": "1.0",
3 - "updated_at": "2026-02-06",
4 - "description": "计划书 form_sn 映射表 - 后端根据产品返回对应的 form_sn,前端根据该字段选择模版组件",
5 - "note": "所有配置细节(币种、缴费年期等)由前端处理,后端只需要返回正确的 form_sn 字段",
6 - "templates": {
7 - "LifeInsuranceTemplate": {
8 - "name": "人寿保险模版",
9 - "description": "用于人寿保险产品的计划书生成"
10 - },
11 - "CriticalIllnessTemplate": {
12 - "name": "重疾保险模版",
13 - "description": "用于重疾保险产品的计划书生成"
14 - },
15 - "SavingsTemplate": {
16 - "name": "储蓄保险模版",
17 - "description": "用于储蓄型保险产品的计划书生成(含提取计划)"
18 - }
19 - },
20 - "mapping": {
21 - "life-insurance-wiop3e": {
22 - "product_name": "WIOP3E 盈传创富保障计划 3 - 优选版",
23 - "template": "LifeInsuranceTemplate"
24 - },
25 - "life-insurance-wiop3": {
26 - "product_name": "WIOP3 - 盈传创富保障计划 3",
27 - "template": "LifeInsuranceTemplate"
28 - },
29 - "critical-illness-mpc": {
30 - "product_name": "MPC 守护无间重疾",
31 - "template": "CriticalIllnessTemplate"
32 - },
33 - "critical-illness-mbc-pro": {
34 - "product_name": "MBC PRO 活跃人生重疾保 PRO",
35 - "template": "CriticalIllnessTemplate"
36 - },
37 - "critical-illness-mbc2": {
38 - "product_name": "MBC2 活跃人生重疾保 2",
39 - "template": "CriticalIllnessTemplate"
40 - },
41 - "savings-gs": {
42 - "product_name": "宏挚传承保障计划(GS)",
43 - "template": "SavingsTemplate"
44 - },
45 - "savings-gc": {
46 - "product_name": "宏挚家传保险计划(GC)",
47 - "template": "SavingsTemplate"
48 - },
49 - "savings-fa": {
50 - "product_name": "宏浚传承保障计划(FA)",
51 - "template": "SavingsTemplate"
52 - },
53 - "savings-lv2": {
54 - "product_name": "赤霞珠终身寿险计划2(LV2)",
55 - "template": "SavingsTemplate"
56 - }
57 - },
58 - "naming_convention": {
59 - "format": "{模版类型}-{产品简称}",
60 - "prefixes": {
61 - "life-insurance-": "人寿保险",
62 - "critical-illness-": "重疾保险",
63 - "savings-": "储蓄保险"
64 - }
65 - },
66 - "api_example": {
67 - "product_list": {
68 - "code": 1,
69 - "data": [
70 - {
71 - "id": 1,
72 - "product_name": "WIOP3E 盈传创富保障计划 3 - 优选版",
73 - "form_sn": "life-insurance-wiop3e"
74 - },
75 - {
76 - "id": 2,
77 - "product_name": "MPC 守护无间重疾",
78 - "form_sn": "critical-illness-mpc"
79 - },
80 - {
81 - "id": 3,
82 - "product_name": "宏挚传承保障计划",
83 - "form_sn": "savings-gs"
84 - }
85 - ]
86 - }
87 - }
88 -}