如何使用视觉效果创建分步说明

已发表: 2017-02-21

有些教程需要的不仅仅是文本,读者才能理解。 通过使用视觉效果创建分步说明,您可以让读者了解可能无法传达的细节。 这些视觉效果可以是静止图像或屏幕截图、动画 GIF、比较图表或视频。 除了帮助读者理解你的内容之外,视觉效果还打破了大量文本的单调。

去年,我一直在 Joyent 担任技术作家,编写说明并制作面向所有技能水平用户的视频。 这需要精确——人们依靠我为技术任务创建分步说明和指南。 如果我错过了一步或假设读者已经知道一条信息,他们可能会沮丧地走开,再也不会回到我们的内容。 另一方面,如果我详细了,内容可能会感觉过多和漫无边际,并且需要更频繁的更新。 无压力。

找到可以用图像代替一些过于精确的细节的地方可以节省我的时间和精力。 另外,读者离开时知道他们期待看到什么,这有望让他们的生活更轻松。 尽可能遵循一些关键的写作建议:展示,不要告诉(非常重要,它有自己的维基百科页面)。

您无需成为技术作家即可从精确的流程用语中受益。 继续阅读以了解准备说明并向任何文档添加视觉效果的策略。

在开始可视化之前,请考虑您的受众

在制作任何内容之前,您应该知道您为谁制作内容以及他们的期望是什么。 虽然不可能预测每个读者的个人需求,但您建立的规则会影响内容的基调,并且可以帮助您稍后在创建流程大纲时做出决策。

观众

考虑以下:

  • 我的读者已经是专家了吗? 他们以前是否做过这个过程,如果不是完全在类似的情况下?
  • 我的读者是内部的还是外部的? 如果我的读者在同一家公司,我们分享什么语言可以帮助更好地解释这个过程?
  • 他们会以什么心情满足我的要求? 我是为急于完成某事的人创建此内容,还是为只是希望在某个主题上进一步学习的更随意的学习者创建此内容?
  • 对我的读者来说最重要的是什么? 什么是最不重要的?
  • 我的读者喜欢如何学习? 我知道博客文章是否比视频更成功吗? 是否有任何分析数据支持这些说法?
  • 我的读者是以英语为母语的吗? 如果我使用成语,会不会妨碍他们学习如何完成流程?

无论你在创造什么,你总是在另一端与读者一起创造它。 您越了解您的读者并为他们制作内容,他们就越有可能继续回来获取更多内容。

仅使用尽可能多的细节来概述流程

为任何媒体准备流程或教程的一种方法是从包含两列的表格开始。 第一列将包含读者完成任务所需的每个单独步骤。 这些步骤可以像“提交申请”一样小而精确,也可以像“完成表格的其余部分”那样大而不具体。

第二列将是您的视觉过程列。 起初,这可能根本不包括任何实际的视觉效果,而是对视觉效果的描述。 如果您正在创建书面文档,则不需要为第一列中的每个步骤提供匹配的视觉效果。 如果您要创建截屏视频,每个框都应该有关于要包含的视觉类型的注释。 视频中应该几乎没有空屏时间。

此表的示例在下面的“示例大纲”下,但首先您必须了解更多有关视觉辅助工具的类型。

视觉效果的类型以及何时使用它们

每个过程都可以从不同类型的视觉效果中受益。 媒介将根据其用途而改变。

  • 静止图像——这是尝试将物理产品可视化的完美媒介,无论是人还是特定对象(如平底锅)。 这些可以是库存照片或您拍摄的照片。
  • 屏幕截图——当谈论在您的计算机上看到的产品(例如网站或其他软件)时,屏幕的静止图像非常有用。 它们非常容易获取和编辑,尤其要感谢 Snagit。
  • GIF – 动画图像非常适合解释可能不太容易表达的简短过程(不到 8 秒)。
  • 图表– 条形图、饼图、折线图等多种图表! 在谈论和比较一组数字时,图表是最佳选择。
  • 视频——终极视觉效果,视频非常适合解释流程。 如何制作出色的技术视频是一种艺术形式,当然可以通过这个过程得到帮助,但需要更多的计划。 (幸运的是,我从 TechSmith 那里学到了很多东西,他们对这个主题还有很多话要说)。

随意在您的写作中使用多种媒介。 每个都将满足不同步骤的不同需求。

示例大纲

食谱是通常需要精确度的过程的最佳示例之一,视觉效果可以产生巨大的差异。 假设我想概述制作蛋糕的说明:

桌子 {

边框折叠:折叠;

}

表,td,th {

边框:1px 实心#404040;

填充:4px;

}

脚步视觉效果
1.收集所有成分以确保没有遗漏。 如果缺少一种成分,请在继续之前获取该成分。 组装好的食材图片
2. 将烤箱预热至 350 华氏度。
3. 在一个 9 x 9 英寸的方形蛋糕盘上涂上油脂并撒上面粉。
4. 在一个中等大小的碗中,将糖和黄油搅匀。 奶油过程的GIF
5. 将鸡蛋一个一个打入碗中,搅拌均匀。
6. 加入香草。
7. 将面粉和泡打粉筛入碗中,搅拌均匀。 可能会留下面粉团块或条纹。 筛选的GIF或成品搅拌产品预乳的照片
8. 加入牛奶搅拌至面糊完全光滑。 完成面糊的照片(可能与步骤 7 的图片并排)
9. 将面糊倒入或舀入准备好的蛋糕盘中。
10. 放入预热好的烤箱烤30-40分钟,蛋糕表面金黄即可。 顶部应该弹回触摸。 蛋糕成品照片

如果每一步都有一个图像,那就有点……无端了。

选择你的视觉效果

我选择的图像有助于在更大的流程中阐明小型流程。 特别是,到目前为止搅拌的第 7 步中的图片是重要的视觉证据。 用这个指令烤了很多蛋糕,恰到好处和过度混合的区别……我希望我总是有一张照片。 可能会有一本说明手册,上面写着混合多长时间的复杂性——每隔一页就必须是一张图片。

在概述了您需要的视觉效果之后,您必须收集货物。 对于此示例,最好为您烘烤蛋糕的过程拍照。 对于其他流程,您可能不需要拍摄自定义照片。 有各种免费和优质的图库摄影网站,其中包含视频、GIF 和静态照片,供您自行决定使用。

与您的目标受众进行测试

在目标受众中的某个人阅读并获得批准之前,没有一篇文章是完整的。 他们的输入将展示您在流程中错过了哪些步骤或需要更多视觉效果的地方。

面试

解决此问题的最简单方法(无需可用性团队的大量资源)是请您的关键人群中的一些人阅读您的内容,并尝试完全按照所写的流程进行操作。 雅各布尼尔森经常被引用说,五个人是捕捉最多问题的最佳人数。

无节制的测试

无节制的测试非常适合资源有限的小型项目——或者只是当您需要快速获得结果时。 您可以使用许多工具来获得更精确的结果,但如果您只是在寻找有关较小流程的反馈,您可能只需将文档发送给您的测试人员并提出您想要的一组问题即可回答。

让您的测试人员在有问题、查看可能遗漏的内容、在过程中遇到障碍或希望他们有更详细的说明时做笔记。 希望他们能够在给您反馈之前完成任务。

适度测试

适度测试的最大好处是,您实际上可以观察您的测试人员执行该过程并查看他们在哪里感到困惑,而不是依靠他们来为您注意到困惑。 如果您记录会话,这样您就不必完全依赖您在会话期间所做的笔记,那就更好了。

一路上问问题。 例如:

  • 您是否了解您被要求执行的任务? 这个任务有意义吗?
  • 什么会使这个过程更容易完成?
  • 如果有一个带有步骤的视觉效果,视觉效果是否有助于您理解该做什么?
  • 你希望有更多的视觉效果吗?

包起来

您现在知道为什么应该在分步说明中添加视觉效果,并拥有一系列工具来帮助您在视觉辅助工具的帮助下成功创建分步说明。 熟能生巧。 您在流程中添加图像的第一次尝试可能并不完美,但是通过一些用户测试来指导您的编辑流程,您将帮助您的用户了解如何完成任务。

您是否有另一种方法来确定何时在说明中添加视觉辅助工具? 在下面的评论中分享您的提示!

编者注:这篇文章最初发表于 2017 年 11 月,为了准确性和全面性已经过更新。