技小云
3.3 KiB
3.3 KiB
title, description, outline
| title | description | outline |
|---|---|---|
| 教程中心 | 开源项目门户的全部教程视频清单与录制排期 | deep |
教程中心
门户下的教程视频按项目组织。视频是这个门户的主交付物之一，文档只作配套与字幕说明，不能替代视频。
视频总表
| # | 项目 | 类型 | 标题 | 时长 | 目标观众 |
|---|---|---|---|---|---|
| V0 | 门户 | 导览 | 雪羊科技开源门户导览：三个项目分别适合谁 | 3 分钟 | 第一次接触本项目的开发者、技术选型者 |
| V1 | iotLCM | 部署 | iotLCM 开源版部署教程：从零到可用 | 12 ~ 15 分钟 | 具备 Linux 与 Docker 基础的实施工程师 |
| V2 | iotLCM | 使用 | iotLCM 开源版使用教程：核心功能实操 | 15 ~ 20 分钟 | 已完成部署、准备给业务方上手的管理员 |
| V3 | iotLCM | 接口 | iotLCM OpenAPI 接入实战：从申请凭证到跑通调用 | 10 ~ 12 分钟 | 要把平台接进自己系统的第三方开发者 |
| V4 | 秀杰 DTU | 部署 | 秀杰 DTU 部署教程：源码起服务到设备接入 | 12 ~ 15 分钟 | 做 DTU 设备接入的开发者 |
| V5 | 秀杰 DTU | 设备 | 秀杰 DTU 设备实操：双通道接入、指令下发与 OTA | 15 ~ 18 分钟 | 设备端与平台端联调工程师 |
| V6 | XiuAdmin | 部署 | XiuAdmin 一键部署：三个容器跑起中后台 | 8 ~ 10 分钟 | 要用这个框架搭中后台的开发者 |
| V7 | XiuAdmin | 二开 | XiuAdmin 框架上手：代码生成到业务模块落地 | 15 分钟 | 要基于框架二次开发的工程师 |
V0 是导览，可选；其余 7 支是必录。
分项目入口
通用录制规范
| 项 | 口径 |
|---|---|
| 录屏环境 | 干净的 Ubuntu 24.04 + Docker Compose V2，不在已有业务实例上录 |
| 画面内容 | 终端为主，浏览器演示为辅；关键步骤要有停顿与高亮 |
| 敏感信息 | 口令、令牌一律打码，示例用编排里的默认值 |
| 可复现 | 视频里出现的每条命令都必须能原样复制执行，与对应文档页严格一致 |
| 命名 | 小写连字符加版本号，如 iotlcm-deploy-v1.mp4，放 website/public/videos/ |
| 字幕 | 每支视频配一份 Markdown 要点说明，随视频一起发布 |
| 发布位置 | 官网对应项目页 + 源码仓 README 顶部 + B 站 |
排期建议
录制顺序按「依赖关系」而非项目分组：先录 V1（部署），因为 V2、V3 都以一套已起好的环境为背景；再录 V4、V5；最后 V6、V7。
建议批次：
- 第一批（3 支）：V0、V1、V2 —— 覆盖门户与主力项目，官网可先上线
- 第二批（2 支）：V3、V4 —— 补齐 iotLCM 接口面向与第二个项目
- 第三批（3 支）：V5、V6、V7 —— 设备实操与框架两支
每批之间留一次审看：命令是否与文档一致、是否可复现、有没有打码遗漏。
验收口径
- 每支视频完整看一遍，步骤无断点
- 视频里的命令在干净环境重跑能通
- 官网对应项目页有该视频的入口，且能播放
- 元数据齐备：标题、目标观众、时长、发布位置、关联文档与仓库路径