技术文档中的视觉元素：一份实用指南
浏览：4
巴克励步
作为Baklib的研究员，我每天都会接触到大量产品文档——从开发文档到用户手册，从帮助中心到企业内部Wiki。说实话，很多团队花了大把时间码字，却忽略了视觉的力量。产品手册建设这件事，本质上是把复杂功能翻译成用户能秒懂的语言。而视觉元素，就是让翻译更精准的“插图”。举个例子，你写十行字描述一个按钮的功能，不如一张截图来得直接。但问题在于，很多人要么不用图，要么用图毫无章法。今天这篇文章，就是来聊聊如
作为Baklib的研究员，我每天都会接触到大量产品文档——从开发文档到用户手册，从帮助中心到企业内部Wiki。说实话，很多团队花了大把时间码字，却忽略了视觉的力量。产品手册建设这件事，本质上是把复杂功能翻译成用户能秒懂的语言。而视觉元素，就是让翻译更精准的“插图”。举个例子，你写十行字描述一个按钮的功能，不如一张截图来得直接。但问题在于，很多人要么不用图，要么用图毫无章法。今天这篇文章，就是来聊聊如何在产品手册中用好视觉，让用户少走弯路。
了解如何以最高效、最易理解的方式传达信息，对于打造一流的技术文档至关重要。
然而，尽管编写技术文档是实现这一挑战的主要技能，但除了文字之外，还有一个重要元素——视觉元素。
视觉元素可以将技术文档提升到另一个层次。关键是要知道如何、何时以及为什么使用它们。
💛🧡🧡客户评价：Baklib 绝对是最好的工具！它易于使用且非常直观。我最初选择 Baklib 来创建我的电子商务网站，但它提供的不仅仅是网站创建。他们通过强大的自定义搜索功能帮助我改善搜索结果，消除了零结果页面，并让用户通过了解他们的意图找到合适的产品。此外，Baklib 通过将所有内容整合到一个平台中简化了网站管理。这使得随时更改和更新内容变得容易，而无需编码技能。得益于其用户友好的界面，Baklib 为我们的营销团队提供了更多的控制权和所有权。
如果你不知道这些问题的答案，别担心，我们将在本文中为你解答。
让我们开始吧！
为什么视觉元素在技术文档中很重要
技术文档肩负着艰巨的任务：以易懂的方式呈现复杂概念，教会读者如何执行特定任务，并提供关于产品的易懂信息。
这一点对于软件产品尤其如此。软件文档可能面向普通用户，也可能面向软件开发者等专家。
能够以清晰易懂的方式向每个目标受众呈现信息，是写作者的“圣杯”。而使用视觉元素是帮助他们实现这一目标的基本实践。
正如《LBCC技术写作》作者Will Fleming所说，在使信息易于理解方面，视觉有时就是比文字更胜一筹。
例如，在为软件创建文档时，你可以使用视觉元素以纯文字无法实现的方式呈现信息。
流行的消息工具Slack在其文档中就充分利用了这一点。例如，他们的开发者文档使用截图来展示可能出现的消息变体。你可能会不以为然，但技术文档中的截图确实对开发团队帮助很大。
没有视觉元素，Slack团队如何展示消息的不同版本？很难想象；他们必须用非常生动的文字来描述消息可能的样子。
此外，Slack使用视觉元素不仅仅是为了让信息更容易理解。它们还用于分割大段文字。
看看他们用户指南中关于通知的示例。
如你所见，他们在此案例中使用了简化截图和项目符号列表。
这样一来，他们在提高理解力的同时，也给读者提供了从阅读中休息的机会。
这是一个很好的组合，能确保读者成功掌握信息。
除了提高理解力和可读性，视觉元素还有助于记忆信息。
根据《大脑规则》作者John Medina的研究，三天后，如果信息伴有图片，人们能记住听到内容的65%，而没有图片则只能记住10%。
因此，通过将信息与视觉元素结合，你可以让信息更具记忆点。
总之，技术文档可以极大地受益于使用视觉元素。
提高理解力、可读性和信息保留率对于提升技术文档的质量至关重要——这也是每个创建者追求的目标。
何时在技术文档中使用视觉元素
正如我们之前提到的，视觉元素是使信息更易获取、更易理解和更易记忆的绝佳方式。
正如技术写作者Kesi Parker所解释的那样，当文字本身不够用时，就会使用视觉元素。
换句话说，视觉元素补充了文字，使信息更有帮助。
例如，你应该使用视觉元素来高效地传达分步说明。
这样，除了描述读者需要采取的步骤来完成特定任务，你还可以说明这些步骤，以最大限度地提高成功几率。
下面你可以看到GitHub在其创建仓库的说明中如何使用这种方法。
为了提供直接的说明，他们使用了编号步骤列表。
除了书面说明之外，对于作者认为需要更多说明的步骤，还提供了两张截图。
那是文字和视觉元素的理想结合。文字完成大部分工作，而视觉元素提供支持和辅助。
像上面这样的指令的有效性得到了研究的支持。
根据TechSmith的数据，67%的人在指令包含截图或视频等视觉元素时，完成任务的成功率更高。
视觉元素也擅长解释复杂的概念。
让我们看看Zapier的例子，Zapier是一个用于集成应用和自动化工作流的软件工具。
在他们的文档中，他们描述了产品的工作原理。简单来说，该工具基于触发器执行自动操作。
这个过程很复杂，用文字表达无疑令人畏惧。因此，作者选择用流程图来阐述。
像这样的视觉元素可以帮助解释软件产品中的复杂概念和细节。
为此有多种视觉类型可供选择，它们都在技术文档中占有一席之地。
让我们在下一节中更仔细地研究它们。
技术文档中使用的视觉元素类型
你可以在技术文档中包含多种类型的视觉元素，使其更加用户友好并对读者更有帮助。
通过组合它们并利用各自的优势，你可以将文档转变为一个轻松传达信息的高质量资源。
以下是一些非常适合此目的的视觉元素：
- 截图
- 列表
- 图表
- 图形
- 视频
- GIF
让我们从我们刚刚在上面使用的列表开始。
列表有不同的类型。正如我们之前提到的，编号列表非常适合向读者提供易于遵循的说明。
另一方面，项目符号列表非常适合突出关键点。
正如你在上面Loom文档的示例中所看到的，使用列表强调信息使其立即引人注目。
这使得列表成为你希望读者特别注意某件事时的绝佳选择。
另一种在技术写作中非常有用的视觉类型是截图。
截图是补充书面说明的好方法。例如，Drift在其文档中通篇使用截图来达到此目的。
他们为在其交易工具中设置钱包、存款和提取的整个过程提供了截图。
如果你使用Baklib作为产品文档工具，这是一件容易的事情，就像Drift的团队所做的那样。
Baklib允许你轻松地嵌入图片、GIF、视频、图表和其他类型的视觉元素。你可以从电脑拖放视觉元素，或粘贴链接。
尽管像上面这样的截图对于提供执行操作的说明无疑很有价值，但视频在这方面很难被击败。
例如，Stripe有一个完整的视频库，为开发者提供说明。
视频可以补充书面说明，但它们也可以完全取代文字。
缺点是它们需要最多的时间和资源来制作，并且并不适合所有场合。
例如，用户可能因为周围环境而无法观看和听视频，或者他们只是想快速浏览一些书面材料，而不是观看十分钟的视频。
这就是为什么技术文档中没有一种理想的视觉类型。组合它们并适当使用是确保良好用户体验的最佳方式。
技术文档中好的视觉元素的标准
技术文档中的视觉元素应该有明确的目的。
无论是图片、视频、图表还是其他东西，都应该帮助读者理解当前的主题。
换句话说，视觉元素不是为了让文档更漂亮而包含进去的。它们的目的是教学、澄清和解释。
技术文档专家Tom Johnson这样表述：
“视觉元素应该增强文字，而不是替代文字。它们应该使信息更容易理解，而不是更难。”
因此，在添加视觉元素之前，问问自己它是否服务于一个真正的目的。如果只是装饰，就省略它。
好的视觉元素还应该与文本紧密集成。它应该被放置在相关文字附近，而不是在页面的底部或另一个章节。
此外，视觉元素应该具有高质量：清晰、标注适当，并且适合读者。
总之，精心选择和使用视觉元素可以显著提升技术文档的质量。关键在于有目的地使用，而不是滥用。
