docs(plan): 添加计划书模块文档索引 README
- 按用途分类文档导航(快速开始/架构/配置/规划) - 提供按场景查找指引(添加产品/理解架构/新员工入职) - 包含核心概念速查表(Schema层级/字段类型/操作符) - 关联代码位置索引,方便开发者快速定位 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Showing
1 changed file
with
150 additions
and
0 deletions
docs/PLAN/README.md
0 → 100644
| 1 | +# 计划书模块文档 | ||
| 2 | + | ||
| 3 | +本目录包含臻奇智荟圈小程序中**计划书模块**的完整技术文档,涵盖架构设计、Schema 规范、快速指南和后端迁移方案。 | ||
| 4 | + | ||
| 5 | +--- | ||
| 6 | + | ||
| 7 | +## 📑 文档导航 | ||
| 8 | + | ||
| 9 | +### 🚀 快速开始 | ||
| 10 | + | ||
| 11 | +| 文档 | 说明 | 适合人群 | | ||
| 12 | +|------|------|---------| | ||
| 13 | +| **[快速使用指南](./plan-entry-quick-guide.md)** | 5分钟集成计划书功能 | 前端开发者 | | ||
| 14 | +| **[计划书模板定义](./计划书模板.md)** | 业务字段需求说明(人寿/重疾) | 业务分析师 | | ||
| 15 | + | ||
| 16 | +--- | ||
| 17 | + | ||
| 18 | +### 🏗️ 架构与设计 | ||
| 19 | + | ||
| 20 | +| 文档 | 说明 | 适合人群 | | ||
| 21 | +|------|------|---------| | ||
| 22 | +| **[录入架构设计](./plan-entry-architecture.md)** | 完整架构设计方案(已批准) | 架构师、后端开发者 | | ||
| 23 | +| **[后端迁移指南](./plan-backend-migration-guide.md)** | 配置架构与迁移方案 | 后端开发者 | | ||
| 24 | +| **[架构图解](./plan-backend-migration-architecture.drawio)** | 可视化架构图 | 架构师 | | ||
| 25 | + | ||
| 26 | +--- | ||
| 27 | + | ||
| 28 | +### 📋 配置规范 | ||
| 29 | + | ||
| 30 | +| 文档 | 说明 | 适合人群 | | ||
| 31 | +|------|------|---------| | ||
| 32 | +| **[Schema 规范参考](./plan-config-schema-reference.md)** | JSON Schema 完整定义 | 前后端开发者 | | ||
| 33 | +| **[Schema 使用指南](./plan-form-schema-usage.md)** | 表单配置与映射实战 | 前端开发者 | | ||
| 34 | + | ||
| 35 | +--- | ||
| 36 | + | ||
| 37 | +### 📊 项目规划 | ||
| 38 | + | ||
| 39 | +| 文档 | 说明 | 适合人群 | | ||
| 40 | +|------|------|---------| | ||
| 41 | +| **[前端开发计划](./前端开发计划.md)** | 30天开发路线图(已更新) | 前端开发者、项目经理 | | ||
| 42 | +| **[项目开发计划](./项目开发计划.md)** | 5周完整项目计划 | 项目经理 | | ||
| 43 | + | ||
| 44 | +--- | ||
| 45 | + | ||
| 46 | +### 📄 附件 | ||
| 47 | + | ||
| 48 | +| 文件 | 说明 | | ||
| 49 | +|------|------| | ||
| 50 | +| **计划书模版.docx** | 储蓄型产品业务需求(第二版) | | ||
| 51 | +| **计划书模版2.docx** | 提取计划详细字段说明 | | ||
| 52 | + | ||
| 53 | +--- | ||
| 54 | + | ||
| 55 | +## 🎯 按场景查找文档 | ||
| 56 | + | ||
| 57 | +### 我想添加新产品配置 | ||
| 58 | + | ||
| 59 | +``` | ||
| 60 | +1. 先读: plan-entry-quick-guide.md (快速集成) | ||
| 61 | +2. 参考: plan-form-schema-usage.md (配置字段) | ||
| 62 | +3. 查阅: plan-config-schema-reference.md (Schema 规范) | ||
| 63 | +``` | ||
| 64 | + | ||
| 65 | +### 我需要理解系统架构 | ||
| 66 | + | ||
| 67 | +``` | ||
| 68 | +1. 先读: plan-entry-architecture.md (架构概览) | ||
| 69 | +2. 再看: plan-backend-migration-architecture.drawio (可视化图) | ||
| 70 | +3. 深入: plan-backend-migration-guide.md (后端方案) | ||
| 71 | +``` | ||
| 72 | + | ||
| 73 | +### 我是新加入的开发者 | ||
| 74 | + | ||
| 75 | +``` | ||
| 76 | +1. 先读: plan-entry-quick-guide.md (快速上手) | ||
| 77 | +2. 再看: plan-form-schema-usage.md (理解配置) | ||
| 78 | +3. 实践: 前端开发计划.md (了解全貌) | ||
| 79 | +``` | ||
| 80 | + | ||
| 81 | +--- | ||
| 82 | + | ||
| 83 | +## 🗂️ 核心概念速查 | ||
| 84 | + | ||
| 85 | +### Schema 层级 | ||
| 86 | + | ||
| 87 | +``` | ||
| 88 | +TemplateConfig (模板配置) | ||
| 89 | + └─ config | ||
| 90 | + ├─ currency (币种) | ||
| 91 | + ├─ payment_periods (缴费年期) | ||
| 92 | + ├─ age_range (年龄范围) | ||
| 93 | + ├─ withdrawal_plan (提取计划) | ||
| 94 | + ├─ form_schema (表单结构) | ||
| 95 | + │ ├─ base_fields (基础字段) | ||
| 96 | + │ └─ withdrawal_fields (提取字段) | ||
| 97 | + └─ submit_mapping (API 字段映射) | ||
| 98 | +``` | ||
| 99 | + | ||
| 100 | +### 字段类型 | ||
| 101 | + | ||
| 102 | +| type | 组件 | 用途 | | ||
| 103 | +|------|------|------| | ||
| 104 | +| `name` | PlanFieldName | 姓名输入 | | ||
| 105 | +| `text` | nut-input | 普通文本 | | ||
| 106 | +| `amount` | PlanFieldAmount | 金额键盘 | | ||
| 107 | +| `radio` | PlanFieldRadio | 单选 | | ||
| 108 | +| `select` | PlanFieldSelect | 下拉选择 | | ||
| 109 | +| `payment_period` | PaymentPeriodRadio | 缴费年期 | | ||
| 110 | +| `date` | PlanFieldDatePicker | 日期选择 | | ||
| 111 | +| `age` | PlanFieldAgePicker | 年龄选择 | | ||
| 112 | + | ||
| 113 | +### 条件操作符 | ||
| 114 | + | ||
| 115 | +| 操作符 | 说明 | | ||
| 116 | +|--------|------| | ||
| 117 | +| `eq` | 等于 | | ||
| 118 | +| `ne` | 不等于 | | ||
| 119 | +| `gt` / `lt` | 大于 / 小于 | | ||
| 120 | +| `gte` / `lte` | 大于等于 / 小于等于 | | ||
| 121 | +| `in` | 包含于 | | ||
| 122 | + | ||
| 123 | +--- | ||
| 124 | + | ||
| 125 | +## 📚 相关代码位置 | ||
| 126 | + | ||
| 127 | +### 配置文件 | ||
| 128 | +- `src/config/plan-templates.js` - 产品模板配置 | ||
| 129 | +- `src/config/plan-fields.js` - 字段定义库 | ||
| 130 | + | ||
| 131 | +### 组件 | ||
| 132 | +- `src/components/plan/PlanFormContainer.vue` - 计划书容器 | ||
| 133 | +- `src/components/plan/PlanTemplates/` - 模板组件(人寿/重疾/储蓄) | ||
| 134 | +- `src/components/plan/PlanFields/` - 字段组件 | ||
| 135 | + | ||
| 136 | +### API | ||
| 137 | +- `src/api/plan.js` - 计划书 API 接口 | ||
| 138 | + | ||
| 139 | +--- | ||
| 140 | + | ||
| 141 | +## 🔗 外部关联文档 | ||
| 142 | + | ||
| 143 | +- **[项目 README](../../README.md)** - 项目概述 | ||
| 144 | +- **[经验教训总结](../lessons-learned.md)** - 开发经验与最佳实践 | ||
| 145 | +- **[接口联调日志](../api-integration-log.md)** - API 集成状态 | ||
| 146 | + | ||
| 147 | +--- | ||
| 148 | + | ||
| 149 | +**文档维护**: 本目录文档由 Claude Code 自动生成和维护 | ||
| 150 | +**最后更新**: 2026-02-25 |
-
Please register or login to post a comment