范智鹏
15d15db5f4
- 新增 docs/demo.mp4（5:00，完整审查工作流演示） - 新增 docs/demo-voiceover.md 演示口播稿 - README 演示视频节改为正式描述并挂视频/分镜链接 - demo-storyboard.md 按实际录制重设计分镜（封面/安装/设置面板/自动分析/全量审查/导出）
30 lines
8.2 KiB
Markdown
30 lines
8.2 KiB
Markdown
# 演示视频分镜脚本（docs/demo.mp4）
|
||
|
||
> 用途：录制 ≤5 分钟演示视频的分镜参考。成片已录制，成品见 `docs/demo.mp4`（时长 5:00），覆盖完整工作流；大赛三要素中的 IDE 集成效果与异常处理因时长限制未纳入，恢复方案见口播稿「超时压缩建议」。
|
||
> 成品存放：`docs/demo.mp4`；README「演示视频」节已更新为正式描述。
|
||
|
||
## 录制准备
|
||
|
||
| 项 | 建议 |
|
||
|---|---|
|
||
| 录屏工具 | OBS Studio（免费）或 VS Code 内置屏幕录制 |
|
||
| 分辨率 | 1920×1080，窗口聚焦 VS Code |
|
||
| 封面素材 | `demo-cover-final-v2.png`（16:9 封面图，已含标题文字） |
|
||
| 示例工程 | `data/efficiency-samples/`（含缺陷的多语言样例，JS/CSS/Java/SQL 混合） |
|
||
| 导入素材 | 预置一份自然语言团队规范文档（如 `team-standard.docx` 或 `.md`，内含数条可识别的编码规范），用于 AI 转换导入演示；模板环节为现场回环：点「导出模板」生成 `code-review-rules-template.xlsx` 后再导入 |
|
||
| 时长 | 大赛要求 ≤5 分钟；多视角演示取消、IDE 集成与异常处理段删除后分镜合计 5:30（超 30 秒），压缩方案见口播稿「超时压缩建议」节 |
|
||
| 语速 | 关键操作配一句口播或字幕说明，不堆话 |
|
||
|
||
## 分镜表
|
||
|
||
| 段 | 时间 | 内容 | 镜头要点 |
|
||
|---|---|---|---|
|
||
| 开场（封面） | 0:00–0:09 | 封面图全屏展示，标题为「净码特工——AI 驱动的多语言代码审查一体化 VS Code 插件」 | 封面定格 9 秒（口播约 40 字需 8–9 秒），念完即切 VS Code |
|
||
| 安装演示 | 0:09–0:25 | 切入 VS Code 窗口 → 打开扩展面板（活动栏方块图标）→ 点击右上角「⋯」→ 选择「从 VSIX 安装…」→ 文件选择框选中打包好的 `.vsix` 安装包 → 右下角通知「扩展已安装，需要重新加载」→ 点击「重新加载」或等待自动生效 → 活动栏出现「净码特工 · Code Purifier」图标 | 扩展面板右上角菜单特写 → VSIX 选项高亮 → 文件选择对话框 → 安装成功通知弹出特写 → 活动栏新图标出现高亮 |
|
||
| 图标介绍 | 0:25–0:32 | 鼠标移动到活动栏新图标上悬停，显示 tooltip「净码特工 · Code Purifier」 | 鼠标悬停特写，tooltip 完整显示停留 2 秒 |
|
||
| 第一步：设置面板总览 | 0:32–3:42 | 点击活动栏图标打开设置面板，从上到下三个区块：①「快速开始」引导——三步上手指引；②「AI 连接配置」——快速扫过服务商、模型、Base URL 与连接状态（已配置好，状态为「✓ 已连接」）；③「审核引擎」三张卡片依次展开演示：**第一张「共通规则」**——适配器列表（ESLint / Stylelint / PMD / SQLFluff）、三级优先级图例（内置 < 项目 < 全局）→ 点开一个适配器卡片 → 点「创建项目配置」→ 项目根目录生成配置文件 → 展示文件内容（默认与内置已开启规则一致）→ 关闭回到面板 → 点「修改全局设置」→ 打开 VS Code 设置页面展示全局配置路径 → 切回面板；**第二张「自定义规则」**——规则列表 → 在规则名称输入框输入名称 → 点「添加」→ 文件选择框选中预置的团队规范文档（自然语言格式，不勾选「使用模板文件导入」）→ 进度通知（AI 读取解析中）→「规则导入预览」弹出：顶部「来源：文件 · 检测到 N 条规则」统计 → 展开一条规则卡片，逐项扫过可编辑字段（id、严重级别、描述、提示语、生效语言、排除语言）→ 演示当场修改一处 → 演示「保留」「注释」切换（重复规则横幅显示与哪条重复及原因；完全重复默认注释导入、点「保留」恢复）→ 点「确认导入」→ 生成 `.code-review/rules/规则名.yaml` → 规则出现在列表中 → 点「导出模板」按钮 → 保存对话框确认，导出 `code-review-rules-template.xlsx` → 在 Excel 中打开模板，重点展示「说明」工作表（各字段含义、取值与填写说明），快速带过「规则」表（字段表头 + 一行 no-todo 示例）→ 切回面板，勾选「使用模板文件导入」（可选：输入新的规则名称与首次导入区分）→ 点「添加」→ 选中刚导出的模板 → 预览快速过目 → 点「确认导入」→ 规则导入完成（口播补充格式报错与修改重导说明：可选配格式错误导入、预览「错误规则」组标红出错字段、改好点「添加」重新校验通过的画面，无则纯口播带过）；**第三张「AI 审核」**——连接状态、供应商、模型、审核能力展示 → 镜头回到「AI 连接配置」区，「保存并测试连接」按钮与「✓ 已连接」状态定格，收束「快速开始」三步引导：与三张卡片交互、配置 AI 连接、保存并测试 | 图标点击特写 → 面板整体滚动一屏 → AI 连接配置区快速扫过（连接状态停留 2 秒）→ 共通规则卡片展开（适配器列表停留 3 秒 → 创建项目配置 → 切到生成的配置文件展示 5 秒 → 切回 → 修改全局设置 → 切到设置页展示 3 秒 → 切回）→ 自定义规则卡片展开（规则名称输入特写 → 点「添加」→ 文件选择框选中规范文档 → 等待 AI 解析 → 预览面板弹出、顶部统计条停留 2 秒 → 展开一条规则卡片、逐个点过可编辑字段、演示修改一处 → 「保留」「注释」按钮切换特写 → 点「确认导入」→ 规则列表出现新规则特写 → 点「导出模板」按钮特写 → 切到 Excel 模板，「说明」工作表停留约 4 秒、「规则」表快速带过 → 切回面板勾选「使用模板文件导入」→ 点「添加」选中模板 → 预览快速过目 → 点「确认导入」）→ AI 审核卡片展开停留 3 秒 → 切回「AI 连接配置」区，「保存并测试连接」按钮与「✓ 已连接」状态特写 2 秒 |
|
||
| 打开文件：自动静态分析 | 3:42–4:10 | 打开示例工程（`data/efficiency-samples/`，四种语言文件）→ 点击打开一个含缺陷文件 → 编辑器自动出现波浪线标记 → 「问题」面板按文件同步汇总诊断（画面扫过，不点击演示）→ 鼠标悬停在波浪线上，Hover 提示展示问题详情 | 文件打开瞬间波浪线出现特写 → 问题面板汇总扫过 2 秒 → Hover 悬停提示完整显示停留 2 秒 |
|
||
| 工作流①：全量审查与报告预览 | 4:10–5:15 | 示例工程已打开（承接上一步）→ 一键审查（`Ctrl+Shift+R`）→ 等待审查执行 → 「代码审核报告」预览画面弹出 → 自上而下扫过按严重级别分组的结果列表 → **依次演示三种来源结果**：静态分析结果（内置规则检出的问题，已翻译成中文并附修复建议，与打开文件时的英文 Hover 形成对照）→ **单条 AI 修复演示**：点静态结果上的「AI 修复」→ diff 预览弹出 → 两步确认 → 写入自动保存 → 报告中该条标记为「已修复」、旁边出现「↩ 撤销」按钮 → **演示点「撤销」**：代码退回修复前、报告刷新、问题恢复待修复 → 自定义分析结果（导入的团队规范规则命中的问题，需确保示例工程中存在可命中代码，如 TODO 注释）→ AI 审核结果（语义级问题，安全/逻辑/性能/设计四维度，不展开举例） | 快捷键按下特写 → 审查执行进度 → 报告预览弹出、严重级别分组停留 2 秒 → 静态分析结果条目特写（翻译后中文诊断停留 2 秒）→ 「AI 修复」按钮点击特写 → diff 预览两步确认特写 → 已修复条目与「↩ 撤销」按钮特写停留 2 秒 → 点「撤销」后代码退回与报告刷新特写 → 自定义分析结果条目特写 2 秒 → AI 审核结果条目特写 2 秒 |
|
||
| 工作流②：报告导出 | 5:15–5:25 | 点「导出报告」→ 生成 Markdown 审查报告快速浏览 | 导出按钮特写 → 生成的 Markdown 报告快速浏览 |
|
||
| 收尾 | 5:25–5:30 | 效果数据卡：23 文件 8.6 秒 / 人工 38.1 分钟 / 提速约 266 倍 / 检出率 27%→100%；仓库地址 | 数据卡片定格 5 秒（数据源：`measurement/timing-log.md`） |
|