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"
- [完整架构文档](./plan-entry-architecture.md)
- [经验教训总结](../lessons-learned/plan-entry-module-summary.md)
- [API 联调日志](../api-specs/API 集成日志.md)
- [API 联调日志](../api-docs/API 集成日志.md)
---
......
......@@ -11,39 +11,46 @@ docs/
├── lessons-learned.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 生成指南
│ ├── SESSIONID_MANAGEMENT.md # SessionID 管理指南
│ ├── auth-debug-guide.md # 认证调试指南
│ ├── TARO_QUICK_REFERENCE.md # Taro 开发速查表
│ ├── apifox-integration-guide.md # Apifox 集成指南
│ ├── changelog-check-guide.md # CHANGELOG 检查指南
│ └── 腾讯元宝AI接入说明.md # 腾讯元宝 AI 接入说明
│ ├── 新人入门指南.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/ # 📊 问题修复与实施报告
│ ├── IMPLEMENTATION_SUMMARY.md # 实施总结
│ ├── COMPLETION_REPORT.md # 完成报告
│ ├── FINAL_FIX_REPORT.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 # 搜索问题分析
│ ├── 实施总结.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 规范文档
│ ├── api-integration-log-template.md # API 联调日志模板
├── api-specs/ # 📝 API 规范文档(按模块组织)
│ ├── 数据文档/ # Mock 数据文档
│ ├── user/ # 用户模块接口
│ ├── file/ # 文件模块接口
│ ├── get_product/ # 产品模块接口
│ ├── news/ # 新闻模块接口
│ └── wechat/ # 微信模块接口
│ ├── wechat/ # 微信模块接口
│ ├── event/ # 事件模块接口
│ ├── favorite/ # 收藏模块接口
│ └── feedback/ # 反馈模块接口
├── api-docs/ # 📘 API 相关文档
│ ├── API 集成日志.md # API 联调日志
│ └── API 集成日志模板.md # API 联调日志模板
├── decisions/ # 📋 技术决策记录
│ └── decisions.md
......@@ -79,21 +86,21 @@ docs/
- 📖 [API 联调日志](api-specs/API 集成日志.md) - 接口联调状态记录
### 新手入门
👉 **[guides/START_HERE.md](guides/START_HERE.md)** - 快速了解项目功能
👉 **[guides/新人入门指南.md](guides/新人入门指南.md)** - 快速了解项目功能
### 开发指南
- 📘 [Taro 开发速查表](guides/TARO_QUICK_REFERENCE.md) - Taro API 快速查阅
- 📘 [OpenAPI 转 API 详细指南](guides/OPENAPI_TO_API_GUIDE.md) - 完整功能说明
- 📘 [GET vs POST 请求处理指南](guides/GET_VS_POST_GUIDE.md) - 参数处理详解
- 📘 [JSDoc 注释生成指南](guides/JSDOC_GENERATION_GUIDE.md) - 注释生成规则
- 📘 [API 使用示例](guides/API_USAGE_EXAMPLES.md) - 实际使用案例
- 📘 [SessionID 管理指南](guides/SESSIONID_MANAGEMENT.md) - 认证会话管理
- 📘 [认证调试指南](guides/auth-debug-guide.md) - 授权流程调试
- 📘 [Taro 开发速查表](guides/Taro 开发速查表.md) - Taro API 快速查阅
- 📘 [OpenAPI 转 API 详细指南](guides/OpenAPI 转 API 指南.md) - 完整功能说明
- 📘 [GET vs POST 请求处理指南](guides/GET vs POST 指南.md) - 参数处理详解
- 📘 [JSDoc 注释生成指南](guides/JSDoc 生成指南.md) - 注释生成规则
- 📘 [API 使用示例](guides/API 使用示例.md) - 实际使用案例
- 📘 [SessionID 管理指南](guides/SessionID 管理指南.md) - 认证会话管理
- 📘 [认证调试指南](guides/认证调试指南.md) - 授权流程调试
### 技术文档
- 📊 [技术实现总结](reports/IMPLEMENTATION_SUMMARY.md) - 实现细节
- 📊 [功能完成报告](reports/COMPLETION_REPORT.md) - 完成情况
- 📊 [修复完成报告](reports/FINAL_FIX_REPORT.md) - 问题修复
- 📊 [技术实现总结](reports/实施总结.md) - 实现细节
- 📊 [功能完成报告](reports/完成报告.md) - 完成情况
- 📊 [修复完成报告](reports/最终修复报告.md) - 问题修复
### 设计文档
- 🎨 [UI/UX 设计稿](design/manulife-V1/done/) - 各页面设计稿
......@@ -134,23 +141,23 @@ UI/UX 设计稿和生成的代码:
## 🎯 使用建议
### 如果你是新开发者
1. 先看 [guides/START_HERE.md](guides/START_HERE.md)
1. 先看 [guides/新人入门指南.md](guides/新人入门指南.md)
2. 阅读 [lessons-learned.md](lessons-learned.md) 了解经验教训
3. 查看 [TARO_QUICK_REFERENCE.md](guides/TARO_QUICK_REFERENCE.md) 快速查阅 API
3. 查看 [Taro 开发速查表.md](guides/Taro 开发速查表.md) 快速查阅 API
### 如果你想了解实现
1. 查看 [reports/IMPLEMENTATION_SUMMARY.md](reports/IMPLEMENTATION_SUMMARY.md)
2. 阅读 [reports/FINAL_FIX_REPORT.md](reports/FINAL_FIX_REPORT.md)
1. 查看 [reports/实施总结.md](reports/实施总结.md)
2. 阅读 [reports/最终修复报告.md](reports/最终修复报告.md)
3. 浏览 [CHANGELOG.md](CHANGELOG.md) 了解历史变更
### 如果你想生成 API
1.`api-specs/` 目录下创建文档
2. 参考 [api-integration-log-template.md](api-specs/api-integration-log-template.md) 记录联调日志
2. 参考 [api-docs/API 集成日志模板.md](api-docs/API 集成日志模板.md) 记录联调日志
3. 运行 `pnpm api:generate`
### 如果你需要调试认证
1. 阅读 [guides/auth-debug-guide.md](guides/auth-debug-guide.md)
2. 参考 [guides/SESSIONID_MANAGEMENT.md](guides/SESSIONID_MANAGEMENT.md)
1. 阅读 [guides/认证调试指南.md](guides/认证调试指南.md)
2. 参考 [guides/SessionID 管理指南.md](guides/SessionID 管理指南.md)
## 📝 维护说明
......
{
"version": "1.0",
"updated_at": "2026-02-06",
"description": "计划书 form_sn 映射表 - 后端根据产品返回对应的 form_sn,前端根据该字段选择模版组件",
"note": "所有配置细节(币种、缴费年期等)由前端处理,后端只需要返回正确的 form_sn 字段",
"templates": {
"LifeInsuranceTemplate": {
"name": "人寿保险模版",
"description": "用于人寿保险产品的计划书生成"
},
"CriticalIllnessTemplate": {
"name": "重疾保险模版",
"description": "用于重疾保险产品的计划书生成"
},
"SavingsTemplate": {
"name": "储蓄保险模版",
"description": "用于储蓄型保险产品的计划书生成(含提取计划)"
}
},
"mapping": {
"life-insurance-wiop3e": {
"product_name": "WIOP3E 盈传创富保障计划 3 - 优选版",
"template": "LifeInsuranceTemplate"
},
"life-insurance-wiop3": {
"product_name": "WIOP3 - 盈传创富保障计划 3",
"template": "LifeInsuranceTemplate"
},
"critical-illness-mpc": {
"product_name": "MPC 守护无间重疾",
"template": "CriticalIllnessTemplate"
},
"critical-illness-mbc-pro": {
"product_name": "MBC PRO 活跃人生重疾保 PRO",
"template": "CriticalIllnessTemplate"
},
"critical-illness-mbc2": {
"product_name": "MBC2 活跃人生重疾保 2",
"template": "CriticalIllnessTemplate"
},
"savings-gs": {
"product_name": "宏挚传承保障计划(GS)",
"template": "SavingsTemplate"
},
"savings-gc": {
"product_name": "宏挚家传保险计划(GC)",
"template": "SavingsTemplate"
},
"savings-fa": {
"product_name": "宏浚传承保障计划(FA)",
"template": "SavingsTemplate"
},
"savings-lv2": {
"product_name": "赤霞珠终身寿险计划2(LV2)",
"template": "SavingsTemplate"
}
},
"naming_convention": {
"format": "{模版类型}-{产品简称}",
"prefixes": {
"life-insurance-": "人寿保险",
"critical-illness-": "重疾保险",
"savings-": "储蓄保险"
}
},
"api_example": {
"product_list": {
"code": 1,
"data": [
{
"id": 1,
"product_name": "WIOP3E 盈传创富保障计划 3 - 优选版",
"form_sn": "life-insurance-wiop3e"
},
{
"id": 2,
"product_name": "MPC 守护无间重疾",
"form_sn": "critical-illness-mpc"
},
{
"id": 3,
"product_name": "宏挚传承保障计划",
"form_sn": "savings-gs"
}
]
}
}
}