From 8b4ba9bb7c0528a3c39d27f8a407c6afab834c48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=8A=80=E5=B0=8F=E4=BA=91?= Date: Thu, 5 Nov 2026 13:05:00 +0800 Subject: [PATCH] =?UTF-8?q?docs(tutorial):=20V2=20=E4=BD=BF=E7=94=A8?= =?UTF-8?q?=E6=95=99=E7=A8=8B=E5=88=86=E9=95=9C=E6=8C=89=E5=90=8E=E5=8F=B0?= =?UTF-8?q?=E7=9C=9F=E5=AE=9E=E8=8F=9C=E5=8D=95=E9=87=8D=E5=86=99=EF=BC=8C?= =?UTF-8?q?=E8=A1=A5=E5=8D=95=E6=94=AF=E8=A7=86=E9=A2=91=E5=BD=95=E5=88=B6?= =?UTF-8?q?=E8=A6=81=E7=82=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pages/guide/videos.md | 15 +++++ pages/projects/iotlcm/guide/tutorial.md | 77 ++++++++++++++++++++++--- 2 files changed, 84 insertions(+), 8 deletions(-) diff --git a/pages/guide/videos.md b/pages/guide/videos.md index 39f48f1..5fee23a 100644 --- a/pages/guide/videos.md +++ b/pages/guide/videos.md @@ -29,6 +29,21 @@ V0 是导览，可选；其余 7 支是必录。 - [秀杰 DTU 教程视频](/projects/xiu-dtu/guide/tutorial) - [XiuAdmin 教程视频](/projects/xiu-admin/guide/tutorial) +## 单支视频的录制要点（以 V2 使用教程为例） + +一支使用类视频要讲清三件事，缺一不可： + +1. **每段开头一句话说清业务问题**——观众得知道「为什么要做这个动作」，不然菜单再全也是流水账 +2. **完整走完一条真实链路**——从入口到结果，中间不跳步、不剪成片段拼接 +3. **交代异常分支**——比如批量动作为什么是异步、失败怎么看，这是使用者真正会卡住的地方 + +按后台真实菜单顺序组织，不按功能模块归类：观众是照着操作走的，菜单顺序就是他的心智路径。 + +以 V2 为例，最小可交付的 8 段是：工作台 → 卡信息 → 入库与库存 → 业务受理 → 批次与执行日志 → 套餐与流量 → 达量断网 → 智能诊断。 +其中「业务受理」「批次与执行日志」「智能诊断」是平台区别于普通 CRUD 的核心，不可省。 + +明确不录的内容也要说清，避免一支视频无限膨胀：OpenAPI 调用归接口那支、通道详细配置归实施方材料、系统管理页归组织与账号类材料。 + ## 通用录制规范 | 项 | 口径 | diff --git a/pages/projects/iotlcm/guide/tutorial.md b/pages/projects/iotlcm/guide/tutorial.md index 974d85c..5e7d7b5 100644 --- a/pages/projects/iotlcm/guide/tutorial.md +++ b/pages/projects/iotlcm/guide/tutorial.md @@ -37,16 +37,77 @@ iotLCM 分三支：怎么装起来、怎么用起来、怎么接进去。前两 | 时长 | 15 ~ 20 分钟 | | 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 | | 关联文档 | [功能概览](/projects/iotlcm/) | -| 关联仓库路径 | `admin-svr/`、`admin-ui/`、`openapi/`、`worker-svr/` | +| 关联仓库路径 | `admin-ui/vue/apps/web-antd/src/views/iotlcm/`、`admin-svr/server/api/iot/v1/` | -分镜： +录制环境：Web 管理端 `http://<主机>:8009/`（部署视频里那套已起好的环境），数据用 mock 挡板或测试库， +不要在压测或生产环境上录。 -1. **卡信息**（3 分钟）：列表检索、按 ICCID / MSISDN / IMSI 三码查卡、卡详情与用量查看 -2. **库存与划拨**（2.5 分钟）：入库后按代理商维度划拨、划拨历史 -3. **资费与业务受理**（3 分钟）：套餐与定价配置、开通 / 续费 / 停复机 / 变更套餐、达量断网阈值 -4. **通道与批次**（3.5 分钟）：通道配置查看、批量操作提交、异步进度与执行日志 -5. **账号与工单**（2.5 分钟）：企业与用户管理、角色权限、告警工单处理 -6. **智能诊断**（1.5 分钟）：结合卡状态、通道与用量出诊断结论 +### 分镜（按后台真实菜单顺序） + +**1. 登录与工作台**（1 分钟） + +- 打开管理端，用 admin 登录（口令打码） +- 进「工作台」看概览：卡总量、在网量、流量与告警概览 +- 一句话交代后台的菜单分组：生命周期、通信管理、资费定价、通道、预警中心、智能诊断、系统与组织 + +**2. 卡信息**（3 分钟）——菜单「通信管理 / 卡信息」 + +- 列表页看全量卡：分页、列筛选 +- 按 ICCID / MSISDN / IMSI 三种卡号任一检索（`cardValue` 支持单卡与批量两种输入） +- 按通道、卡状态、套餐编码再叠一层筛选，体现组合筛选能力 +- 点开一张卡的详情：基本信息、状态、有效期、绑定套餐 +- 说明列表右上角的导出（导出当前显示列） + +**3. 入库与库存**（2.5 分钟）——菜单「生命周期 / 入库管理」「库存卡信息」 + +- 入库管理：Excel 模板下载 → 批量导入卡 → 导入结果反馈（成功 / 失败条数） +- 库存卡信息：看在库卡、按状态与维度筛、看单卡出入库轨迹 +- 串一句：入库是所有下游动作（划拨、激活、续费）的前提 + +**4. 业务受理**（3 分钟）——菜单「通信管理 / 业务受理」 + +- 新建受理单：选卡 → 选动作（开卡 / 复机 / 停机 / 续费 / 变更套餐 / 销户）→ 提交 +- 提交前确认卡状态与套餐是否满足该动作的前置条件 +- 提交后到「批次管理」看任务生成 +- 顺带展示销户卡信息页与库存的差别 + +**5. 批次与执行日志**（3 分钟）——菜单「生命周期 / 批次管理」「执行日志」 + +- 批次管理：看批次列表、批次类型（开停复机 / 续费 / 变更套餐）、处理进度 +- 打开一个批次的卡明细：逐卡的成功 / 失败与失败原因 +- 执行日志：看异步执行记录与耗时，失败批次点详情看日志 +- 说明这里为什么是异步：批量动作走 worker 队列，页面只提交不等待 + +**6. 套餐与流量**（2.5 分钟）——菜单「资费定价」 + +- SIM 流量套餐：看套餐定义、有效期、生效与到期策略 +- 流量池：看池的总量与已用量 +- 流量池套餐配置：池与套餐的绑定关系 + +**7. 达量断网**（1.5 分钟）——菜单「通信管理 / 达量断网」 + +- 新建规则：选池 / 选套餐、设阈值与动作 +- 说明触发时机与卡状态的关系：这是运营商侧断网前的自保手段 + +**8. 智能诊断**（1.5 分钟）——菜单「智能诊断」 + +- 输入卡号，查诊断信息：基本信息 + 会话信息 + 套餐信息三块同屏 +- 查该卡的流量使用情况 +- 说明诊断给的是「当前结论 + 依据」，处置仍要回到对应菜单操作 + +### 录制注意 + +- 上面 8 段是**必须录到**的最小集合。若时间紧，4（业务受理）、5（批次与执行日志）、8（智能诊断）三段是平台区别于普通 CRUD 的核心，不可省 +- 每一段开头用一句话说清「这一步在业务上解决什么问题」，观众跟得上 +- 卡号、IMEI 用演示值；不要展示真实客户名与真实生产卡号 +- 批次那段的异步特性建议当场等一次执行结果（mock 环境秒级），让观众看到状态从「执行中」到「成功」 +- 全程不要出现真实口令与 token + +### 明确不录的内容 + +- OpenAPI 调用演示 → 属于 V3 接口那支 +- 通道与接入模板的详细配置 → 属于平台实施方内容，不是业务方日常操作 +- 租户、角色、菜单的系统管理页 → 与使用教程的受众不匹配，放进「组织与账号」类材料 ## V3 OpenAPI 接入实战