Files
2026Technology-Competition/docs/demo-voiceover.md
T
范智鹏 15d15db5f4 docs: 补入演示视频与口播稿,README 去「进行中」占位
- 新增 docs/demo.mp4(5:00,完整审查工作流演示)

- 新增 docs/demo-voiceover.md 演示口播稿

- README 演示视频节改为正式描述并挂视频/分镜链接

- demo-storyboard.md 按实际录制重设计分镜(封面/安装/设置面板/自动分析/全量审查/导出)
2026-09-13 16:02:53 +08:00

194 lines
13 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 演示视频口播稿(配合 demo-storyboard.md 使用)
> 对应分镜:`docs/demo-storyboard.md`(封面开场 + VSIX 安装 + 三卡片依次演示版)
> 全稿约 1380 字;多视角句删去、IDE 集成与异常处理段取消后,全片预计 5:30,超出大赛 ≤5 分钟要求约 30 秒,压缩方案见文末「超时压缩建议」
## 使用说明
- 语速基准:每秒 4.5–5 字(正常讲解语速);第一步设置面板段信息最密,须边操作边说、句间不留空,其余段落关键数字前稍作停顿
- 分段录制:八段分开录,命名 `01-open``08-end`,剪辑时按时间轴对齐
- 停顿标记:文中(停顿)处等画面动作完成再继续念,宁长勿短
- 数字交给画面:数据卡上的 23 文件 8.6 秒、266 倍、27%→100% 等数字均不逐字朗读,全部交给画面呈现
- 示例选择:口播不点名具体问题,AI 修复与各来源高亮演示的条目以实际审查结果为准,录制时选有代表性的真实问题
- 内容边界:只讲功能、数据与使用方式
## 分段口播
### 开场(封面)(0:000:09,约 40 字)
> 各位评审好,这是我们队伍的参赛作品:净码特工——AI 驱动的多语言代码审查一体化 VS Code 插件。
(封面图全程展示,念完即切入 VS Code)
### 安装演示(0:090:25,约 60 字)
> 下面开始演示,首先需要安装。
>
> 安装很简单:打开 VS Code 扩展面板,选择从 VSIX 安装,选择打包好的安装包进行安装,等待几秒即可安装完毕。
(切入 VS Code 时念第一句;点菜单、选文件时念第二句;安装成功通知弹出时稍停)
### 图标介绍(0:250:32,约 30 字)
> 安装完成后,左侧活动栏会出现净码特工的图标,这就是插件的主入口。
(鼠标移到图标上、tooltip 显示出来时念)
### 第一步:设置面板总览(0:32–3:42,约 870 字)
> 点击图标,这就是插件的设置面板。
>
> 最上方是「快速开始」引导,方便用户三步上手;中间是 AI 连接配置,用来接 AI 服务;下方是审核引擎,包含共通规则、自定义规则和 AI 审核三张卡片。
>
> (停顿)
>
> 接下来看审核引擎的三张卡片。
>
> 第一张,共通规则:集成了 ESLint、Stylelint、PMD、SQLFluff 四个静态适配器,配置按内置、项目、全局三级优先级自动生效。
>
> 每个适配器都可以独立开关,按需选用,灵活适配不同项目的技术栈。
>
> 项目配置和全局配置也都支持按项目灵活调整,满足不同团队的定制需求。
>
> (停顿,点开一个适配器卡片)
>
> 点「创建项目配置」,会在项目根目录生成一份配置文件,默认内容就是内置配置里已开启的规则,拿来就能用。
>
> (停顿,展示生成的配置文件)
>
> 再点「修改全局设置」,可以配置全局路径,多个项目共用同一份规则。
>
> (停顿,切回面板)
>
> 第二张,自定义规则:可以导入团队自己的编码规范。
>
> (停顿,在规则名称输入框输入名称)
>
> 先输入规则名称,再导入规则文件。YAML 格式的结构化规则可以直接导入,拿来即用;
>
> 如果团队的规范是用自然语言写的,也可以用 AI 自动转换成结构化规则。支持 Excel、Word、PPT、Markdown 或 TXT 文档。
>
> (停顿,点击「添加」,选中一份团队规范文档,等待 AI 解析)
>
> AI 会读取并分析这份文件,自动识别其中的规则,展示在预览画面里。
>
> (停顿,「规则导入预览」面板弹出)
>
> 预览里能看到每条规则的 id、严重级别、规则描述、提示语、生效语言、排除语言,每一项都能当场编辑修改。
>
> 为了保证规则不重复,导入前还有一道自动去重:新规则会与内置规则和已有的自定义规则逐一对照——完全重复的默认注释导入、不会重复生效,部分重叠的明确标注出来,留给你取舍。
>
> (停顿,点「确认导入」按钮)
>
> 确认无误,点「确认导入」——规则立即生效,出现在规则列表里。
>
> (停顿,点击「导出模板」按钮,打开模板文件展示)
>
> 想达到生成规则跟预想结果一模一样,可以通过点「导出模板」,导出一份 Excel 规则模板,然后根据「说明」工作表进行填写。
>
> (停顿,切回面板,勾选「使用模板文件导入」,点击「添加」,选中模板文件)
>
> 填好后,勾选「使用模板文件导入」,点「添加」选中文件,同样在预览里过目,确认导入,规则就进来了。
>
> (可选镜头:切一次格式错误的导入,预览「错误规则」组标红出错字段;无此画面则直接口播带过)
>
> 如果导入的文件没有按照模板格式填写,也会有相应的报错,错误内容不会被导入到规则中。
>
> 根据报错提示改好对应的字段,点「添加」重新校验,通过后就能正常导入了。
>
> 第三张,AI 审核:显示连接状态和审核能力,AI 深度审查就是从这里驱动的。
>
> (停顿,镜头回到「AI 连接配置」区,「保存并测试连接」按钮特写)
>
> 整个上手跟着「快速开始」的三步引导走:与三张卡片交互、配置好 AI 连接,最后点「保存并测试连接」——插件就可以正常使用了。
### 打开文件:自动静态分析(3:42–4:10,约 110 字)
> 配置好后,打开示例工程,文件一打开,编辑器里就出现了波浪线标记,问题面板也同步按文件汇总出诊断——这是插件在打开文件时自动执行的静态分析,无需手动触发。
>
> (停顿,鼠标悬停在波浪线上)
>
> 把鼠标悬停在波浪线上,Hover 提示直接展示问题详情,不用离开编辑器。
### 工作流①:全量审查与报告预览(4:10–5:15,约 250 字)
> (停顿,按 Ctrl+Shift+R
>
> 按 Ctrl+Shift+R 快捷键,全量审查启动。审核结果会出现在代码审核报告预览画面中,并且静态通道给出的诊断结果,也会被翻译成目标语言。
>
> (停顿,等待审查完成,「代码审核报告」预览画面弹出,镜头自上而下扫过)
>
> 这就是代码审核报告预览画面:结果按严重级别分组,错误、警告一目了然。
>
> (停顿,高亮静态分析结果)
>
> 先看静态分析结果:内置规则检出的问题,已经翻译成了中文并附上修复建议。
>
> (停顿,点这条问题上的「AI 修复」按钮,弹出 diff 预览,两步确认后写入代码)
>
> 发现了问题当场就能修:点「AI 修复」,先给 diff 预览,两步确认后写入、自动保存。
>
> (停顿,镜头回到报告画面,这条问题标记为「已修复」,旁边出现「↩ 撤销」按钮,点「撤销」后代码退回修复前、报告刷新)
>
> 如果不满意,可以通过「撤销」,代码原样退回,问题也回到待修复列表里。
>
> (停顿,高亮自定义分析结果)
>
> 再看自定义分析结果:刚才导入的团队规范规则也生效了,检出的问题同样汇总在这里。
>
> (停顿,高亮 AI 审核结果)
>
> 最后看 AI 审核结果:专挖静态规则查不出来的语义级问题,覆盖安全、逻辑、性能、设计四个维度。
>
### 工作流②:报告导出(5:15–5:25,约 25 字)
> 审查结果支持一键导出 Markdown 报告,方便存档和分享。
### 收尾(5:255:30,约 25 字)
> 净码特工,让每一行代码都值得信赖。感谢各位评审!再见!
(数据卡定格,静默收尾)
## 各段时长与字数对照
| 段 | 画面时长 | 口播字数 | 朗读约用时(4.5–5 字/秒) | 留白与节奏提示 |
|---|---|---|---|---|
| 开场(封面) | 9 秒 | 40 | 8–9 秒 | 口播念完即切 VS Code |
| 安装演示 | 16 秒 | 60 | 12–13 秒 | 约 3 秒(等安装完成通知) |
| 图标介绍 | 7 秒 | 30 | 6 秒 | 1 秒(tooltip 停留) |
| 设置面板总览 | 190 秒 | 870 | 174193 秒 | 全片最密段落:边操作边讲;规范文档解析等待、预览卡片展开、模板展示、模板回环导入、「保存并测试连接」收束五处静默 2–4 秒;格式报错与修改重导句为纯口播补充、不占独立镜头 |
| 打开文件自动静态分析 | 28 秒 | 110 | 2224 秒 | 打开工程与文件、Hover 悬停两处操作与口播同步推进;问题面板汇总画面扫过、不点击演示 |
| 工作流①全量审查与报告预览 | 65 秒 | 250 | 50–56 秒 | 快捷键按下后静默等审查完成;报告预览弹出扫过、静态结果高亮、单条 AI 修复(diff 两步确认)、已修复条目与「撤销」按钮特写、点「撤销」退回、自定义/AI 结果依次高亮等操作与口播同步推进 |
| 工作流②报告导出 | 10 秒 | 25 | 5–6 秒 | 约 4 秒(导出按钮与生成的报告) |
| 收尾 | 5 秒 | 25 | 5 秒 | 数据卡定格静默收尾 |
> 全片口播合计约 1380 字,分镜合计 5:30。收尾致谢句保持全片最慢语速。
## 超时压缩建议
删去多视角句、取消 IDE 集成与异常处理段后,全片 5:30 超出大赛 ≤5 分钟要求约 30 秒。执行方案:
1. **预览讲解换精简版**(省约 10 秒):AI 识别与预览段压缩为「AI 读取分析文件、自动识别规则,展示在预览里;每条规则的 id、严重级别、描述、提示语、生效语言、排除语言都能当场编辑;导入前自动去重,完全重复默认注释导入、部分重叠明确标注」
2. **整体语速提至 5–5.5 字/秒**(省约 25 秒):专业讲解偏快但仍清晰,适合功能密集的参赛演示;收尾致谢句仍放慢
3. **删减/压缩单句**(备选,合计约 26 秒,按优先级从低到高候选):
- 「项目配置和全局配置也都支持按项目灵活调整,满足不同团队的定制需求」(约 6 秒)
- 格式报错两句(「如果导入的文件没有按照模板格式填写,也会有相应的报错,错误内容不会被导入到规则中。根据报错提示改好对应的字段,点「添加」重新校验,通过后就能正常导入了」)压缩为「格式不符会有相应报错、错误内容不会被导入;改好重新校验即可导入」(约 8 秒)
- 三种来源结果演示三句(「先看静态分析结果:……再看自定义分析结果:……最后看 AI 审核结果:……」)压缩为「静态诊断已翻译成中文、附修复建议;导入的自定义规则同样生效;AI 审核专挖语义级问题、覆盖四个维度」(约 12 秒)
推荐组合:方案 1 + 2 合计约省 35 秒,压至 4:55,无需删句即回到 5:00 内。注意:大赛规范要求的三要素中 IDE 集成效果与异常处理两段已删,若须恢复演示(两段约加回 25 秒至 5:55),可再叠加方案 3 首项(约 6 秒)、图标介绍段并入安装演示段一并念(约 7 秒)、VSIX 与文件选择框及模板 Excel 展示画面加速(约 10 秒),合计压至约 4:57,仍能回到 5:00 内但节奏很紧。
## 录音建议
- 每段单独录一条,方便对齐时间轴和替换重录
- 功能句语速稍快、结论句放慢;收尾致谢句是全片收束,念得最慢
- 环境安静即可,无需配乐;若加字幕,字幕与口播文字保持一致
- 开场问候语气自然、语速稍慢,体现礼貌
- VSIX 文件选择对话框的画面可以适当加速,口播保持正常语速
- 三张卡片依次展开时节奏要稳,每张卡片展开后稍作停留让观众看清内容
- 自定义规则卡按「输入规则名称 → 点「添加」导入规范文档 → AI 解析 → 预览弹出(讲 AI 识别与可编辑字段)→ 讲去重(演示「保留」「注释」切换)→ 确认导入 → 导出模板 → 展示模板 → 勾选「使用模板文件导入」→ 点「添加」选模板 → 预览过目 → 确认导入 → 格式报错与修改重导说明(纯口播带过,或配错误导入、改好字段点「添加」重新校验的画面)」顺序推进,每步等画面就位再念下一句;第二次导入前建议输入新的规则名称,与首次导入区分
- 创建项目配置和修改全局设置的操作画面是重点,口播与画面动作严格对齐
- 设置面板段收束句(「快速开始」三步)配镜头回到「AI 连接配置」区「保存并测试连接」按钮的画面,念完「插件就可以正常使用了」再切示例工程,与下一段「配置好后」自然衔接
- 「打开文件」段按「打开示例工程 → 打开文件(波浪线自动出现、问题面板同步汇总)→ Hover 悬停看详情」顺序推进,每处等画面就位;Hover 提示完整显示后停留约 2 秒再念下一句
- 「全量审查」段按「按 Ctrl+Shift+R → 等审查完成、报告预览弹出 → 自上而下扫过严重级别分组 → 高亮静态分析结果 → 点该条的「AI 修复」,diff 预览两步确认写入、自动保存 → 报告中该条变为「已修复」、旁边出现「↩ 撤销」按钮(停留约 2 秒)→ 点「撤销」、代码退回、问题恢复待修复 → 高亮自定义分析结果 → 高亮 AI 审核结果(各停留约 2 秒)」顺序推进;静态结果里翻译后的中文诊断与打开文件时的英文 Hover 形成前后对照