feat: 教程中心页与三项目教程视频清单（8 支视频含分镜）

2026-11-05 11:52:48 +08:00
parent 6944652966
commit a6eb3ffc98
6 changed files with 234 additions and 32 deletions
@@ -1,65 +1,77 @@
 ---
 title: 教程视频
-description: 部署与使用的录屏教程
+description: iotLCM 开源版的部署、使用与接口接入录屏教程
 outline: deep
 ---

 # 教程视频

-开源版的上手路径只有两条：**把平台跑起来**（部署）与**把平台用起来**（使用）。两条路径各一支录屏视频，文字文档只作配套说明，不替代视频。
+iotLCM 分三支：怎么装起来、怎么用起来、怎么接进去。前两支面向实施与业务方，第三支面向第三方开发者。

-## 部署教程
+## V1 部署教程：从零到可用

 | 项 | 内容 |
 | --- | --- |
 | 标题 | iotLCM 开源版部署教程：从零到可用 |
-| 目标观众 | 第一次接触本项目、具备 Linux 与 Docker 基础的开发者与实施工程师 |
+| 目标观众 | 具备 Linux 与 Docker 基础的实施工程师 |
 | 时长 | 12 ~ 15 分钟 |
-| 发布位置 | 官网本页 + 代码仓 README 顶部 + B 站 |
+| 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 |
 | 关联文档 | [快速开始](/projects/iotlcm/guide/quickstart)、[部署与运维](/projects/iotlcm/guide/deploy) |
 | 关联仓库路径 | `deploy/`、`docs/` |

-视频覆盖：
+分镜：

-1. 环境准备：Docker 与 Compose 版本检查、端口占用确认、机器规格建议
-2. 取代码：`git clone` 公开仓库，确认目录结构
-3. 启动：`docker compose up -d`，观察 MySQL 初始化日志直到种子数据导入完成
-4. 验证：登录管理端、打开文档站与 OpenAPI 文档、跑一次状态查询
-5. 收尾：改默认口令、停栈与清理数据卷
+1. **环境准备**（1.5 分钟）：Docker 与 Compose 版本检查、机器规格建议、端口占用确认
+2. **取代码**（0.5 分钟）：`git clone` 公开仓库，展示目录结构
+3. **启动**（4 分钟）：`cd deploy && docker compose up -d`，`docker compose logs -f mysql` 看初始化直到种子数据导入完成
+4. **验证**（3 分钟）：登录管理端、打开文档站 `/docs/`、打开 OpenAPI 文档、跑一次卡状态查询
+5. **收尾**（2 分钟）：改默认口令清单、`docker compose down` 与 `down -v` 的区别
+6. **踩坑预告**（1 分钟）：MySQL 初始化失败要清卷、文档站必须带 `/docs/` 路径

-## 使用教程
+## V2 使用教程：核心功能实操

 | 项 | 内容 |
 | --- | --- |
 | 标题 | iotLCM 开源版使用教程：核心功能实操 |
 | 目标观众 | 已完成部署、准备给业务方上手的管理员与运营人员 |
 | 时长 | 15 ~ 20 分钟 |
-| 发布位置 | 官网本页 + 代码仓 README 顶部 + B 站 |
+| 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 |
 | 关联文档 | [功能概览](/projects/iotlcm/) |
 | 关联仓库路径 | `admin-svr/`、`admin-ui/`、`openapi/`、`worker-svr/` |

-视频覆盖：
+分镜：

-1. 卡信息：列表检索、按三码查卡、卡详情与用量查看
-2. 库存与划拨：入库后的代理商维度划拨
-3. 资费与业务受理：套餐配置、开通/续费/停复机、达量断网
-4. 通道与批次：通道配置查看、批量操作与异步进度
-5. 对外接口：申请 API 凭证并完成一次真实调用
-6. 账号与工单：企业用户与角色、告警工单处理
+1. **卡信息**（3 分钟）：列表检索、按 ICCID / MSISDN / IMSI 三码查卡、卡详情与用量查看
+2. **库存与划拨**（2.5 分钟）：入库后按代理商维度划拨、划拨历史
+3. **资费与业务受理**（3 分钟）：套餐与定价配置、开通 / 续费 / 停复机 / 变更套餐、达量断网阈值
+4. **通道与批次**（3.5 分钟）：通道配置查看、批量操作提交、异步进度与执行日志
+5. **账号与工单**（2.5 分钟）：企业与用户管理、角色权限、告警工单处理
+6. **智能诊断**（1.5 分钟）：结合卡状态、通道与用量出诊断结论

-## 视频文件放置约定
+## V3 OpenAPI 接入实战

-成片放在代码仓的 `website/public/videos/` 下，文件名用小写连字符加版本号（如 `deploy-tutorial-v1.mp4`），页面里以相对路径引用：
+| 项 | 内容 |
+| --- | --- |
+| 标题 | iotLCM OpenAPI 接入实战：从申请凭证到跑通调用 |
+| 目标观众 | 要把平台接进自己系统的第三方开发者 |
+| 时长 | 10 ~ 12 分钟 |
+| 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 |
+| 关联文档 | 文档站 OpenAPI 合同章节 |
+| 关联仓库路径 | `openapi/`、`docs/` |

-```html
-<video controls src="/videos/deploy-tutorial-v1.mp4"></video>
-```
+分镜：

-若改投 B 站等外部托管，页面保留外链入口即可，视频文件不进仓库（避免仓库体积膨胀）。
+1. **申请凭证**（2 分钟）：管理端申请 API 凭证、看凭证与权限范围
+2. **鉴权方式**（2 分钟）：JWT 令牌获取、令牌与权限的关系
+3. **第一次调用**（3 分钟）：卡信息查询接口的请求参数、响应结构、逐字段解释
+4. **错误处理**（2 分钟）：常见业务错误码与参数校验失败的处理路径
+5. **兼容接口**（1.5 分钟）：旧版兼容接口与 V3 的差异，何时该用哪套
+6. **收尾**（1 分钟）：接入自检清单

 ## 录制备忘

- 录屏环境用与观众一致的环境：干净的 Ubuntu + Docker Compose V2，不要在已有业务实例上录
- 涉及口令的片段一律打码，示例口令用编排里的默认值
+- 录屏环境用干净 Ubuntu + Compose V2，不在已有业务实例上录
+- 涉及口令的片段一律打码，用编排里的默认值
 - 步骤与[快速开始](/projects/iotlcm/guide/quickstart)严格一致，视频里出现的每条命令都必须能原样复制执行
 - 每个视频产出配套字幕或要点说明（Markdown），随视频一起发布
+- 视频文件命名 `iotlcm-deploy-v1.mp4` 这类，官网用相对路径引用；改投外部托管则不进仓库
@@ -0,0 +1,55 @@
+---
+title: 教程视频
+description: XiuAdmin 中后台框架的一键部署与二开实操录屏教程
+outline: deep
+---
+
+# 教程视频
+
+XiuAdmin 是开发底座而不是业务系统，两支视频分别回答「怎么跑起来」和「怎么用它写自己的业务」。
+
+## V6 一键部署：三个容器跑起中后台
+
+| 项 | 内容 |
+| --- | --- |
+| 标题 | XiuAdmin 一键部署：三个容器跑起中后台 |
+| 目标观众 | 要用这个框架搭中后台的开发者 |
+| 时长 | 8 ~ 10 分钟 |
+| 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 |
+| 关联文档 | 代码仓 `deploy/README.md` |
+| 关联仓库路径 | `deploy/`、`build/` |
+
+分镜：
+
+1. **三个容器是什么**（1.5 分钟）：MySQL 8.0、Redis 7.2、前后端一体应用，MySQL 与 Redis 只在内部网络可达、不映射宿主端口
+2. **一条命令启动**（3 分钟）：`cd deploy && ./run.sh`，看它自动生成 `.env`（随机数据库口令、Redis 口令、JWT 密钥，权限 600）、拉镜像、起容器、等健康检查通过
+3. **访问与改密**（1.5 分钟）：打开 `http://<服务器IP>:8199/`，初始账号 admin / 123456 登录后立即改密
+4. **常用命令**（1.5 分钟）：`status` 看状态与健康检查、`logs` 跟日志、`restart` 改 `.env` 后重建应用容器、`down` 保留数据卷、`destroy` 清数据需二次确认
+5. **手工部署路线**（1 分钟）：`cp .env.example .env` 后用 `docker compose up -d`，说明 `.env` 里各变量含义（镜像前缀、APP_TAG、APP_PORT、四个口令、JWT_SIGNING_KEY 必须够长且随机）
+
+## V7 框架上手：代码生成到业务模块落地
+
+| 项 | 内容 |
+| --- | --- |
+| 标题 | XiuAdmin 框架上手：代码生成到业务模块落地 |
+| 目标观众 | 要基于框架二次开发的工程师 |
+| 时长 | 15 分钟 |
+| 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 |
+| 关联文档 | 代码仓 `README.md` 的内置功能清单与目录说明 |
+| 关联仓库路径 | `server/`、`vue/` |
+
+分镜：
+
+1. **框架全貌**（2 分钟）：GoFrame2 后端 + Vue3 前端（Vben Admin）+ Ant Design Vue，单仓结构（`server/`、`vue/`、`docs/`、`build/`、`deploy/`）与「前后端一体镜像」的思路
+2. **代码生成**（4 分钟）：建表 → 简单配置 → 生成 CURD / 树表 / 消息队列 / 定时任务代码，表单控件勾选即生成
+3. **生成代码怎么接进系统**（3 分钟）：生成的 API、控制器、菜单权限如何挂进路由，前端页面如何挂进菜单
+4. **多租户与数据权限**（2.5 分钟）：租户与租户套餐、角色按机构或上下级关系划数据范围
+5. **异步与通知**（2 分钟）：Asynq 消息队列怎么用、WebSocket 实时推送通知公告与私信
+6. **运维视图**（1.5 分钟）：在线用户、定时任务、服务监控、缓存监控、附件大文件分片上传
+
+## 录制备忘
+
+- 录屏环境用干净 Ubuntu + Docker，不要连生产或预演环境
+- 口令一律打码，`run.sh` 生成随机口令这一步可展示但值要遮住
+- 代码生成那段用一个明显的示例表（如 demo_order），避免观众误以为是框架内置表
+- 步骤与代码仓 `deploy/README.md` 严格一致，视频里的每条命令都要能原样复制执行
@@ -0,0 +1,58 @@
+---
+title: 教程视频
+description: 秀杰 DTU 管理平台的部署与设备实操录屏教程
+outline: deep
+---
+
+# 教程视频
+
+秀杰 DTU 分两支：把服务起起来并让设备连上，然后在平台上真的操作一遍设备。
+
+## V4 部署教程：源码起服务到设备接入
+
+| 项 | 内容 |
+| --- | --- |
+| 标题 | 秀杰 DTU 部署教程：源码起服务到设备接入 |
+| 目标观众 | 做 DTU 设备接入的开发者 |
+| 时长 | 12 ~ 15 分钟 |
+| 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 |
+| 关联文档 | 代码仓 `docs_ui/` 文档站（快速上手、通信协议、控制台说明） |
+| 关联仓库路径 | `server/`、`vue/`、`docs_ui/`、`docker/`、`deploy/` |
+
+分镜：
+
+1. **环境准备**（1.5 分钟）：Go 1.25+、Node.js 24+ 与 pnpm 10+、MySQL 8、Redis 7 的版本检查
+2. **初始化数据库**（2 分钟）：建库 `xiujie_dtu` 并按顺序导入四个初始化 SQL（基础表、业务表、菜单、角色）
+3. **配置后端**（1.5 分钟）：复制 `config_default.yaml` 为 `config.yaml`、改数据库与 Redis 连接、设置 JWT 签名密钥环境变量（长度不少于 32 位，未提供时服务拒绝签发令牌）
+4. **启动后端**（2.5 分钟）：`go run main.go`，说明三个监听端口的用途：控制台 5689、设备 HTTP 5692、设备 TCP 5690
+5. **启动前端与文档站**（2 分钟）：`pnpm install && pnpm dev`（前端 5688）、`npm run docs:dev`（文档站 5687）
+6. **登录与改密**（1 分钟）：初始 admin 账号登录后立即改密
+7. **Docker 部署路线**（2 分钟）：`docker/dtu_base` 初始化中间件 → `docker/dtu_iot` 部署业务服务、`make docker-build docker-push` 构建推送镜像
+
+## V5 设备实操：双通道接入、指令下发与 OTA
+
+| 项 | 内容 |
+| --- | --- |
+| 标题 | 秀杰 DTU 设备实操：双通道接入、指令下发与 OTA |
+| 目标观众 | 设备端与平台端联调工程师 |
+| 时长 | 15 ~ 18 分钟 |
+| 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 |
+| 关联文档 | 代码仓文档站「通信协议」章节（HTTP API、TCP 帧、指令、属性上报、配置同步、OTA、UART 隧道） |
+| 关联仓库路径 | `tools/`、`server/`、`docs_ui/` |
+
+分镜：
+
+1. **HTTP 通道联调**（3 分钟）：用 `tools/test-device-http-v4.sh` 带 DEVICE_KEY / PRODUCT_KEY / PROJECT_KEY 打一次设备注册与上报，看平台侧设备列表出现
+2. **TCP 通道联调**（3 分钟）：`tools/test-device-tcp-v4.py --heartbeat --listen-command` 建连、维持心跳、接收平台下发指令
+3. **指令下发**（2.5 分钟）：从控制台对设备下指令，两端同时看帧与日志
+4. **属性上报与配置同步**（2.5 分钟）：设备上报属性、平台侧改配置并下发，验证端到端一致性
+5. **OTA 升级**（2.5 分钟）：研发中心建固件版本、发起 OTA 升级任务、看设备侧升级结果
+6. **UART 隧道**（1.5 分钟）：透传串口数据的用法与适用场景
+7. **压测**（2 分钟）：`tools/stress-2w-devices.py --count 20000` 演示 2 万设备压测怎么发起、看指标
+
+## 录制备忘
+
+- 录屏环境用干净 Ubuntu，MySQL / Redis 独立装，不要连生产或预演环境
+- DEVICE_KEY / PRODUCT_KEY / PROJECT_KEY 等示例值用文档里的测试值，画面出现即可
+- 2 万设备压测那段只演示命令与指标入口，不在录屏环境真压 2 万台
+- 步骤与代码仓文档站的「快速上手」严格一致，视频里的每条命令都要能原样复制执行