ClickHelp功能:上下文帮助

文档交付是一个非常重要的过程,可以以不同的格式提供。 您可以发送PDF文件,发送打印的文档或在线托管文档。 拥有在线文档非常有用,因为您可以立即与用户共享任何主题,并且他们可以在其Web浏览器中直接打开它。 但是,您可以走得更远,并在需要澄清的任何地方直接在应用程序中插入部分文档。 这样,用户可以查看其他信息,而无需切换到另一个网页甚至其他应用程序(如果我们正在谈论移动设备)。 这称为上下文帮助

上下文帮助有多种形式。 有时,它只是指向描述某个功能或提供说明的特定主题的链接。 这是最简单的解决方案,但不是一个坏方案,但是您的用户仍然必须切换到另一个页面或应用程序。

更好的解决方案是用户可以在应用程序的UI内直接获得帮助。 它可以是一个小的弹出窗口,也可以是在用户需要时滑出的辅助面板。

如今,Web应用程序可以轻松地将富文本弹出窗口与图像甚至视频结合在一起。

可以为Context Help手动创建代码,但是可能很耗时。 当您将ClickHelp用于在线文档时,有一种更简便,更快捷的方法。

ClickHelp立即为Context Help项目生成代码。 由于我们的帮助创作工具基于主题,因此使该过程变得容易。 上下文帮助的整个思想是,此类内容通常不能作为单个技术文档获得。 通常,仅使用一份技术文档来描述特定的应用程序状态。 而且,在使用ClickHelp的情况下,这些“片段”已经以单独的帮助主题的形式存在。

为什么上下文帮助是一个好主意

为什么使用上下文帮助如此有益? 答案很简单-随着用户满意度的提高,采用这种方法的使用时间将大大减少。

用户手册,即使是最基本的形式,也是提高产品采用率的良好工具。 但是借助高质量的上下文帮助,您的客户无需打开技术文档即可了解您的应用程序基础。 用户去其他地方获取信息的次数越少,他们在产品内部获得的帮助就越多-越好。 一些用户可能不愿意阅读用户手册。 好吧,实际上我们大多数人都不喜欢阅读冗长的文档。 但是,当内容交付的部分内容与您在应用程序中当前所做的工作高度相关时,这会更好地工作-您阅读了几行文本,并且知道了继续进行所需的一切。

请记住,将用作上下文帮助元素的主题可能需要重新设计。 它们包含的信息应该简洁明了,最重要的是,从用户可以在UI中找到它的上下文中可以清楚地看到消息。 与标准帮助主题不同,上下文弹出窗口必须为用户的问题或关注提供准确,直接的答案。 该弹出窗口可能具有“了解更多”链接,可打开包含更多信息的更大主题。

ClickHelp中的上下文帮助

ClickHelp支持多种类型的上下文帮助,例如:

  • 简单链接(可以将它们设置为以不同的方式运行,例如,打开弹出窗口,在新窗口中打开主题等)
  • 键盘快捷键
  • 弹出式视窗
  • 辅助面板

可以使用几个非常简单的步骤在ClickHelp中创建上下文帮助:

  • 选择您想要变成上下文帮助项的主题。 请记住,您可以在这些主题中使用图像和视频,并确保它们在弹出窗口中看起来不错。
  • 转到主题的“属性”。

  • 在此处找到“上下文帮助”部分

  • 在这里,您可以根据自己的喜好设置“上下文帮助”元素:

选择上下文帮助类型(弹出窗口或辅助面板),指定元素的大小,定义弹出行为等。ClickHelp允许通过在设置下方呈现示例上下文元素来预览结果,因此您可以看到结果看起来像。

  • 将代码粘贴到应用的HTML页面中。

要将Context Help元素添加到应用程序的屏幕,您将需要与Developers一起插入生成的HTML代码。 完成此阶段后,将从您的文档门户动态提取这些元素的内容。 通过收听用户反馈,可以轻松地改善Context Help内容,运行实验并评估结果。

您可以在此页面上看到在ClickHelp中创建的Context Help元素在现实生活中的外观。

结论

拥有高质量的用户手册有很多好处。 其中之一是-您可以将帮助主题变成应用程序中的产品导览,或添加信息图标,这将对您的用户有很大帮助。 我们试图使用ClickHelp创建一个非常简单直观的过程,希望您喜欢!

祝您技术上写好运!
ClickHelp小组
跨平台和设备编写,托管和交付文档