如何与 Michele Wiedemer 一起编写有用的帮助内容

已发表: 2020-10-28

什么是帮助内容?

您不必成为技术作家来创建帮助人们使用您的产品的内容。 您的内容需要帮助您的客户自助。

客户教育内容可帮助客户解决问题并执行他们需要的任务。 提供此内容是确保您的产品在客户中取得成功的重要因素。

有多种方法可以创建有效的帮助资源,在这篇文章中,Michele Wiedemer 分享了她 20 年来创建、评估和改进面向客户的帮助内容的知识。


您可以在这篇文章的顶部观看有关此主题的视频,收听播客节目,点击下面的播放,或继续阅读以了解更多信息……

什么是客户教育?

客户教育正在帮助最终用户成功使用您的产品。 Michele 创建有用的内容,赋予用户使用产品完成任务的技能和动力。

教育客户使他们能够成功是任何有用内容的核心。 但 Michele 知道,帮助内容可能不仅仅是一个快速查找的文档。

“我对有用的内容和培训的交叉点非常感兴趣。 对于其他类型的材料,无论是培训还是营销,甚至是在销售过程中,您如何才能拥有此基线? 你怎么能教人们他们需要知道的东西?”

每个人都应该知道如何编写帮助内容吗?

书面沟通技巧很重要,Michele 在她的 TechSmith Academy 课程“编写有用的帮助”中详细介绍了改进这些技巧的基础知识。

但是,当涉及到帮助内容时,必须优先考虑你的写作方式和写作对象。 同情客户的需求是您将如何创建有用的内容。

通过设计和创建仅服务于最终用户的帮助内容,它将更加有效。 它需要是他们可以轻松处理并最终从中学习的文档或工具。

“这是我真正希望人们从中得到的一件事,就是善解人意。”

人们在创建客户教育内容时犯的错误

写太多是人们在创建帮助内容时常犯的错误。

将整个主题缩减为两句话似乎很愚蠢,但帮助内容少即是多。 分解和简化流程是确保您的用户能够遵循您的内容试图教给他们的内容的最佳方式。

如果您包含太多信息,最终用户可能会难以找到问题的答案或学习新流程。

Michele 的建议是对您包含的信息保持批判性和选择性。 首先画出关键点并将它们按易于处理的顺序排列。 然后考虑是否需要收集到的任何额外信息。 也许您根本不需要包含它。

创建较短的内容比创建较长的内容要困难得多。 然而,米歇尔有一个技巧可以帮助她消除不必要的信息。

“真正对我帮助很大的一件事是,一旦我开始制作教程视频并自己进行旁白,我就会大声朗读出来。 一旦你大声读出来,你就会开始意识到,哇,我不需要那么多字。 我可以这样说更快。”

如何决定创建什么类型的帮助内容

帮助内容的一些示例包括培训指南、教学视频、教程,甚至电子学习。 任何帮助用户完成任务的内容都是客户教育内容,但是您如何选择创建哪种类型的内容呢?

米歇尔最好的建议是从定义你的目标开始。 在做出任何内容决定之前,请先了解您希望您的内容帮助用户实现什么。

“如果你真的很清楚你想要完成什么,就可以更容易地找出你需要的正确产品。”

决定创建什么类型的内容的另一个好方法是与用户交谈。 找出他们喜欢使用哪些类型的内容,或者哪些内容类型可以帮助他们解决问题。 毕竟,客户教育内容只有在客户使用它时才有用。

如何编写帮助内容

一旦您了解了高级信息,例如您的目标和您的受众,您就可以开始编写您的客户教育内容。 Michele 有一个创建内容的三步过程,并在她的写作有用的帮助TechSmith 学院课程中详细解释了它。

第一步是决定写什么。 这包括选择您需要涵盖的主题以及您将要包括的所有内容。 Michele 建议从标题开始将信息分解为“块”。

第一个块应该是与用户遇到的问题或痛点相关的基于操作的标题。 下一部分是“对我有什么好处?” 声明,它告诉读者内容将帮助他们实现什么。

其他块包括使用地标来帮助用户浏览内容、可操作的步骤以及增强读者体验和简化流程的屏幕截图或图像。

第二步是让您的内容在设计意义上易于阅读。 您的内容需要看起来不错并且可以扫描。 用户需要能够通过扫描文档来快速查找信息。

您可以通过使用编号列表、项目符号、相关的粗体文本以及图像等视觉标记来帮助实现这一目标。 这些视觉效果帮助用户找到他们需要的东西,而不会陷入文本中。

第三步是让您的内容易于查找。 考虑用户如何找到您的内容并让他们轻松到达那里。

如果您的读者找不到它,它可能不存在

无论这意味着针对搜索引擎优化它还是给它一个清晰的标题以便它可以在其他有用文档的文件夹中脱颖而出,如果他们无法轻松访问它,您的帮助内容将无法帮助任何人。

如果您的平台允许,Michele 提倡使用类别来分类和显示您的帮助内容。 她强调,你应该组织你的内容以使其符合逻辑,以便人们知道如何寻找它。

Michele 还建议使用超链接来控制掉进信息兔子洞的感觉。 通过将超链接放入文档并清楚地标记它们,用户可以以有节制的方式在信息之间移动以了解更多信息。

“使用超链接的一种非常有效的方式是说,我在这里只谈论这一件事,这里有所有其他相关的事情。”

同理心在有用的帮助内容中的重要性

如果你制作了好的内容,这将对搜索引擎和阅读它的人有好处

Michele 的最终想法是关于什么使帮助内容有效。 她的建议是确保您从同情的地方创建帮助内容。

您无需使用昂贵的特殊软件让用户惊叹。 这不是好的有用内容的原因。 最有用的帮助内容使用能够有效传达信息的软件,无论是文本文档还是屏幕截图视频。

虽然对您的内容进行 SEO 以帮助搜索引擎找到它很重要,并且使用屏幕截图为用户提供更多上下文可能是有益的,但所有这些块应该结合起来创造一个有用的用户体验。

因此,当您创建帮助内容时,请设身处地为用户着想,帮助您的客户自助。

要了解有关创建更好的客户教育内容的更多信息,请查看 TechSmith 学院的 Michele 课程,编写有用的帮助:https://academy.techsmith.com