By Bri Hillmer on Support from May 10, 2021
"We need to move towards contextual help." For awhile now this statement has been bandied about when discussing the future of SurveyGizmo's software documentation.
I've said it. My boss, the manager of customer experience, has said it. His boss, the director of development, has said it. I'm pretty sure I've heard similar statements from the director of service and probably even the CEO. It has turned into what feels like an imperative.
What's troubling is that I, the documentation coordinator, don't have a firm vision of what contextual help should ideally look like in SurveyGizmo. This is the obvious first step towards implementing contextual help. So, I've set out to get a better understand of contextual help, why it works, and when it doesn't.
Contextual help, also referred to as context-sensitive help, is
. . . a kind of online help that is obtained from a specific point in the state of the software, providing help for the situation that is associated with that state.[1]
Because contextual help is rarely a one-size-fits-all scenario there are many different forms of contextual help. The best help is a combination of many of these options.
Inline instructions are probably the most common form of contextual help. The below example from SurveyGizmo shows the user the format in which the time should be entered as well as the time zone.
Inline Instructions in SurveyGizmo
Tooltips are another commonly used form of contextual help. Tooltips are typically used to define ambiguous terms or interface elements. Below is a Google Analytics Tooltip.
Google Analytics Tooltip
An embedded help center is simply a help center that is accessible within the software. In many cases, this is the extent of the "context" that is applied to an embedded help center. Typically, in embedded help centers the onus is still on the user to find the content that answers their question though some embedded help centers point to articles that are relevant to the current page.
Realtime Board Embedded Help Center
Another familiar example of an embedded help center is the help tool available in Office products like Excel.
Microsoft Excel Embedded Help Center
Embedded help might be the rarest breed of contextual help. Embedded help provides users with the specific answers or steps they need within the software without the need for the user to search for it. Embedded help can be triggered to display by either the user or the software.
Embedded Help in Gmail
Guided tours and walkthroughs are a sequence of positioned tooltips that guide users through an interface. A guided tour works as a demo, showing users the process first and then letting them follow it, while a walkthrough takes the users through the process step by step.[2]
Realtime Board Tutorial
Having not yet implemented contextual help this question is top of mind for me. It behooves me to evaluate the pros and cons of contextual help to be sure that this is the direction I want to go before diving in head first. Below are is the list of advantages of contextual help I have found in my research.
As with all things, there are potential downsides to contextual help. Here is the list of potential problems with contextual help.
Help is a funny thing. Unless you're in the business of writing help content, you don't really notice it (unless it is really bad). Most of the time the help just helps you and you're not going to walk away raving about how it did its job.
Fortunately, I am in the business of writing help content and love thinking about it, talking about it. I am perpetually in reconnaissance mode when it comes to help. Recently, the contextual help of Realtime Board and Slack have really stood out to me!
Realtime board has an excellent two-minute video at the beginning of the trial that gives the user a great idea of the available features.
The also have a pretty great tutorial to get you oriented.
Realtime Board Tutorial
I'm a huge fan of Slack's help. Here is their getting started tour.
Slack Tour
They also have an adorable and helpful robot you can chat with called Slackbot. You can ask Slackbot questions about how to do things in Slack.
Slack's Slackbot
General posts useful to all documentarians about writing documentation, editing and publishing workflows, and more.
Your flight plan for how to get the most out of KnowledgeOwl features and integrate them into your workflows.
Major KnowledgeOwl company announcements.
Learn how others are using KnowledgeOwl & get pro tips on how to make the most of KO!
Find out more about who we are and what we value.
We believe good support is the foundation of good business. Learn about support tools and methodology.
Learn more about tools to solve various documentarian issues, within and beyond KnowledgeOwl.
Not sure what category you need? Browse all the posts on our blog.
Watch a 5-minute video and schedule time to speak with one of our owls.