技术写作者的屏幕录制指南
学习如何使用屏幕录制创建更清晰的技术文档,减少支持工单数量,提升用户入门体验。
技术写作者的屏幕录制指南
静态截图和大段文字只能发挥有限作用。用户会跳过长段落,误解注释,错过编号列表中隐藏的关键步骤。屏幕录制通过按顺序准确展示该做什么,消除歧义,解决了这些问题。
本指南介绍技术写作者如何使用 Recorded 制作高质量的文档视频,从而减轻支持负担并提升产品采用率。
为什么技术文档需要视频
基于文本的文档适合参考资料——API 参考、配置选项、概念说明。但对于程序性内容(“我怎么做 X?”),视频通常更快被理解,也更难产生误解。
对技术写作者的主要优势:
- 减少歧义:观看者看到的是精确的 UI 状态,而非文字描述的近似情况
- 降低支持量:能跟随视频操作的用户几乎不会为同一任务提交工单
- 加快入门速度:新用户无需向导即可学习复杂工作流
- 跨越语言障碍:制作良好的视频比翻译文本更能跨越语言障碍
规划录制会话
优质的文档视频在按下录制按钮之前就已开始。
先为步骤编写脚本
像编写编号程序一样写出每个步骤。这将成为你的录制脚本。如果某个步骤难以书写,录制起来也会很难——将此作为简化方法的信号。
选择正确的捕获模式
- 窗口捕获:适用于大多数文档工作。将应用程序与桌面杂乱隔离,为观看者提供干净、专注的视图。
- 全屏:适合需要展示多个应用程序之间或系统级交互的上下文。
- 自定义区域:适用于捕获大型应用程序中的特定面板或小部件。
决定说什么和展示什么
并非所有内容都需要旁白。有些操作在屏幕上一目了然。规划你的旁白来添加为什么的上下文,让视频展示怎么做。
文档录制设置
使用以下设置进行文档质量的录制:
- 分辨率:以原生显示分辨率捕获。如需要,在导出时降低分辨率。
- 帧率:30fps 最为理想——在不增加文件大小的情况下,UI 交互足够流畅。
- 光标可见性:始终保持光标可见。观看者需要追踪你点击的位置。
- 系统音频:除非相关,否则禁用。通知声和背景噪音会干扰旁白。
有效捕获
复杂操作时放慢速度
在执行拖放、键盘快捷键、上下文菜单等多步骤交互时,要有意识地移动光标。录制时感觉缓慢的操作在播放时看起来是自然的。
在关键操作前暂停
在每个重要操作前暂停半秒,让观看者在发生变化前有时间定位当前位置。这对键盘快捷键特别有帮助,因为那里没有可见的 UI 提示。
使用窗口捕获保持专注
只捕获应用程序窗口可以保持文档整洁。观看者不会被桌面、其他打开的窗口或浏览器标签页分散注意力。
文档编辑
积极修剪
文档视频应尽可能简短。删除以下内容:
- 等待 UI 响应的长时间停顿
- 偏离相关区域的时刻
- 重复尝试某个操作的部分
在小型 UI 元素上添加缩放效果
许多文档场景涉及小按钮、图标或文本字段。使用 Recorded 的缩放效果在交互时刻将观看者拉近——然后缩小以展示结果。
文档缩放的最佳实践:
- 在点击之前而非之后放大
- 保持缩放足够长,让观看者阅读任何标签或文本
- 返回正常视图以展示操作的完整结果
使用光标高亮
启用光标高亮使点击点更加明显。点击时的视觉脉冲消除了对选择内容的任何疑问。这对密集界面中的操作特别有用。
使每个视频专注于一个任务
抵制将多个程序合并到一个长视频中的诱惑。短小、任务专注的视频更易于查找、共享,以及在产品 UI 变化时维护。
将视频集成到文档中
视频与书面步骤配对
视频和文本相互补充。为喜欢浏览的用户保留文档中的书面步骤。为喜欢观看的用户在程序正上方或正下方嵌入视频。
使用描述性文件名和标题
命名视频文件和嵌入标题以反映具体任务:使用 create-api-key.mp4,而非 tutorial-video-3.mp4。这使文档库在规模化时易于维护。
文档站点的导出格式
用于嵌入文档平台(Confluence、Notion、GitBook、ReadMe):
- MP4(H.264):跨平台和浏览器的最佳兼容性
- 分辨率:根据内容密度选择 1280×720 或 1920×1080
- 文件大小:尽可能将每个视频控制在 50MB 以内——大文件会拖慢页面加载速度
建立视频库
与源文件一起维护所有文档视频的结构化文件夹。当产品发布 UI 更改时,更容易识别和重新录制过时内容。
维护:保持视频最新
文档视频有其生命周期。UI 更新使视频过时的速度比书面内容更快。通过以下方式减轻影响:
- 在主要 UI 发布时重新录制:优先处理显示已更改导航或重新设计界面的视频
- 在视频说明中添加”最后验证”日期:向用户表明内容的时效性
- 保持录制简短:较短的视频比长篇演练重新录制成本更低
文档视频清单
发布任何文档录制之前:
- 所有步骤可见且顺序清晰
- 光标始终可见
- 对小型或关键 UI 元素应用缩放效果
- 删除不必要的停顿
- 音频清晰,无背景噪音
- 视频长度尽可能短
- 以适当分辨率导出为 MP4 格式
- 在文档中与书面步骤配对
结论
屏幕录制是技术写作者工具箱中最未被充分利用的工具之一。与书写良好的程序一起使用时,它们可以减少歧义、增强用户信心,并减少所涵盖任务的支持量。
从最常见的支持查询开始——用户最频繁提出的问题正是清晰、专注的录制能产生最大影响的地方。