创建有效的操作指南来吸引受众

已发表: 2024-10-01

同事多久会打断你寻求帮助?

您是否知道 46% 的员工每天被打扰六次以上? 在我们对工作场所灵活性的研究中,这些员工报告说生产力下降或压力更大。

通过一些文档来提高每个人的生活质量。这里有您舒适、自信地创建分步操作说明所需的一切。

分享程序、解释和方法的机会无处不在。

  • 您是否对团队成员进行新流程培训?
  • 让客户使用您的商业产品或服务?
  • 促进新人力资源软件的公开注册?
  • 指导如何清空咖啡渣?
  • 为客户知识库做出贡献?

让我们学习如何制作操作指南。

停止重复问题

使用 Snagit 创建清晰的视频和指南,这样您只需解释一次任务。

免费试用
仪表板的屏幕录制,显示转化率、支出和每月绩效,并带有微笑男子的画中画网络摄像头视图。

分步说明是内部知识库的一部分

快速教程是完成特定任务的分步指南。

  • 清晰 - 读者应该能够遵循这些步骤。通常,这意味着将文本与图片或视频结合起来。
  • 吸引人 – 组织指南以吸引读者的注意力并帮助他们节省时间。
  • 相关信息 - 提供上下文和用例,帮助读者理解为什么它对他们有价值。

知识库的其他重要部分有所不同

  • 培训手册 – 不要试图取代深入培训或认证课程。
  • 参考指南 – 专注于您的受众可以实现的一个特定目标。
  • 用户手册 – 包括一些提示、警告或知识,而不是每种边缘情况。
  • 博客文章 - 简化面向客户的营销策略和营销活动的内容。或者用案例研究或项目符号列表来代替,以帮助做出购买决策。

第 1 步:了解目标受众的痛点

“测量两次,切割一次。”为了确保客户体验,前期额外的时间是值得的。

找出他们的痛点

在开始之前,请确定您的目标受众、他们的目标以及他们的痛点或需要通过指南解决的知识差距。它可能有助于:

  • 进行调查
  • 仔细阅读在线论坛
  • 征求客户反馈

根据受众的技能水平和观点定制指南

您还想了解读者对该主题的舒适度。不同的受众有不同的技能水平。 优秀的操作指南适合目标受众的技术能力,无论是初学者还是专家。

查看现有培训或教育材料的搜索词和反馈。与您的客户支持团队联系,深入了解客户体验。了解受众使用的关键字,例如在互联网搜索中。他们用什么语言来描述主题、他们的麻烦或困惑点?

第 2 步:构建指南

“就像 1-2-3 一样简单”——创建分步编号列表和要点

毫不奇怪,编号列表比密集的文本墙更容易理解。将您的指南分解为离散的步骤或可管理的块。

请记住,您的听众在阅读时可能会在您的指南和任务之间来回切换。对步骤进行编号或字母有助于观众跟上。

文字墙?下一个!

Snagit 可以轻松地通过视觉进行更有效的沟通。

了解更多
有关海雀迁徙模式的文档的屏幕截图,其中突出显示了更改样式的部分。

遵循指南模板

如果您的组织创建多个指南或系列,请考虑使用指南模板。根据同一模板构建的一致指南可帮助您的读者了解会发生什么。它还使组织中的其他人更快、更轻松地编写说明和创建指南!

例如,考虑在您的模板中包含一个介绍来识别:

  • 指南的目标受众。
  • 指南的目标,或者读者期望实现的目标。
  • 完成该过程所需的软件、工具或资源。
  • 联系信息或帮助资源,以防读者遇到麻烦。

考虑模板中的结论:

  • 为了回顾本指南的目的或目标,您的读者现在应该能够做什么?
  • 该系列中的后续步骤或后续指南
  • 联系信息或帮助资源

请务必查看 Snagit 的现成、专业设计的模板。我们甚至有一类“步骤”模板,旨在在单个页面上容纳 2-6 个步骤。还可以修改这些模板,以便根据需要在更多页面上添加附加步骤!

Snagit 中的指南模板

第 3 步:编写分步说明

创建清晰简洁的步骤

现在是时候写了!

我没有依赖我的记忆(诚然很差),而是首先自己完成任务,并记下每一步。特别是对于我经常执行的熟悉任务,观察新用户的潜在障碍非常重要。

确保指南中使用的语言和术语与用户在屏幕上看到的一致。

当心!问问自己是否有一些地方您所看到的可能与观众所看到的不同,或者步骤可能有所不同。例如,您的读者是否可能使用不同的软件版本、操作系统或浏览器?

添加图片

我在执行任务时实时截取屏幕截图或照片。

图像有助于说明步骤或提供上下文。它们有助于确保您的指南易于理解,并且无论您的受众的技能水平如何,他们都可以遵循。

使用箭头、注释或标签对图像进行注释。这些类型的视觉效果可确保读者将文本和图像联系起来。

操作指南中图像的注释示例

请务必从图像中删除无关的细节,这些细节可能会迷惑读者或分散读者的注意力。

还记得您在步骤 1 中确定的受众及其熟悉程度吗?您是否需要解释在屏幕上哪里可以找到每个项目?

例如,当您告诉某人单击“设置”按钮并解释它看起来像齿轮时,这可能会有所帮助。您可能还需要强调屏幕上容易错过的图标或重复元素的位置。

注释阐明了图像中的信息

第 4 步:添加其他信息和资源

包括相关链接和资源

如果指南中记录的任务需要或可以补充其他资源,请务必将其包括在内。这些可能是项目源文件或相关或更深入教程的链接。

这可能包括其他产品的下载链接。您的操作指南不应是伪装的销售或营销页面。如果其他软件更适合您的受众的需求,请提供指导,尤其是在存在免费选项的情况下。

提供上下文和背景

帮助您的读者了解为什么您的指南对他们有用。包括相关示例或他们在遵循指南后应该能够做什么。

在复杂的过程中,在指南中提供背景信息可以证明特定步骤的必要性。这种额外的上下文可以帮助用户掌握流程背后的原因,尤其是在不熟悉的情况下。

使用 Snagit 注释和编辑屏幕截图

专业的标记工具和强大的功能使创建有用的图像变得容易。

免费试用
有关海雀迁徙模式的文档的屏幕截图,其中突出显示了更改样式的部分。

第 5 步:测试您的操作指南

确保准确性和可用性

一旦编写了带有支持视觉效果的书面步骤列表,请检查您的指南的准确性:

  • 您是否遗漏了任何步骤?
  • 语言与读者所看到的一致吗?
  • 对于软件指南,请确保说明对于读者可能使用的所有版本都是准确的。或者,指定所涵盖的特定版本并提供有关在何处获取其他版本帮助的信息。

让另一个人审查您的指南(尤其是不熟悉该过程的人)总是一个好主意。此人可以像实际的新用户一样为您进行测试。如果您不确定某些区域是否清楚,请突出显示那些需要审阅者特别注意的区域。

此人可以帮助确保您的文档不仅准确而且易于遵循:

  • 语言是否清晰易懂?
  • 是否有过于复杂的步骤需要进一步分解?
  • 是否包含正确的图像以提供清晰度和背景?

知道有人可能会发现错误或建议改进您的文档可能会让人感到不舒服。然而,如果您充分利用您的团队来发现潜在问题,您的读者更有可能成功。

如果没有其他人可以查看该指南,请自己仔细阅读以确保准确性和可用性。假设您没有在最后期限内完成操作指南,请等待一两天再进行查看。这将帮助您以全新的视角来阅读本指南,就像您是新用户一样。

根据反馈进行修改

当然,根据评论根据需要修改指南。准备好接收受众的反馈,并愿意根据需要迭代您的指南。

有关操作指南的反馈示例

第 6 步:发布并分发您的指南

选择合适的平台

当需要发布指南时,请考虑最佳的发布位置和方法。需要考虑的一些事项:

  • 如果此文档是内部的,则使其易于查找可以显着提高工作效率。
  • 如果面向公众,您的指南是否需要分发?例如,销售团队或客户成功经理向新客户发送电子邮件?
  • 或者,如果放置在您的网站上,您的目标受众将如何找到它?
  • 如果您打算广泛分享您的指南,最好发送在线链接,而不是使用 PDF 或在各个地方发布。在单个位置管理指南以方便更新并防止过时版本传播。
  • 您的一些读者是否会提出对其他人有帮助的问题、评论或提示?考虑将您的指南发布到具有内置对话的平台,例如 Screencast。

优化搜索引擎优化

如果公开发布,您的目标受众将如何找到您的指南?

确保您的说明与屏幕上的内容相符。在可行的情况下,指南的描述性部分应反映读者的语言。

在第一步中研究你的受众将使你深入了解他们的语言。将其纳入您的指南中以帮助人们找到它。

考虑使用 SEO 优化工具,例如 SEMrush 或 WordPress 的 Yoast 插件。改进 SEO 可以提高在需要时查找内容的能力。

回顾:编写实用操作指南的最佳实践

使用简单、直接的语言

评估实用操作指南的最关键部分是确定它是否易于遵循。使用用户可以理解的简单、直接的语言,无论他们的技能水平如何。

包含图像以阐明每个步骤

帮助避免读者感到困惑。通过每个步骤的带注释的屏幕截图或照片来显示您的意思。

定期更新您的指南

定期查看和更新​​指南,确保指南保持准确。如果在线提供,更新还有助于提高搜索引擎优化和排名。

重要的部分:让自己变得轻松

不要让创建操作指南比培训本身花费更长的时间!

使用 Snagit,屏幕捕获软件的市场领导者。您一定会喜欢使用一体化解决方案来进行屏幕捕获、GIF 创建、注释、模板和灵活的导出选项。

停止重复问题

使用 Snagit 创建清晰的视频和指南,这样您只需解释一次任务。

免费试用
仪表板的屏幕录制,显示转化率、支出和每月绩效,并带有微笑男子的画中画网络摄像头视图。