Note: To create and edit a Guide a user must have Author access.
What is a guide?
A guide is a step-by-step instruction set provided to the end users within the application that the user is completing their process/task in. A guide can be used in a variety of scenarios.
-
New users onboarding
-
Product tours
-
Important process changes
-
New Features
-
Improve process compliance
Creating a guide
It is important to understand the right candidate for creating a guide. If the screens are simple enough, without a lot of deviations with a couple of fields that need more context/help for the end user, tooltips may be a better choice.
However, if the process is prone to a lot of errors and requires users to follow steps in a specific order, a short guide would be a better choice.
To create a guide, open the knowledge hub and click ‘Create’ button and select ‘Create guide’ option.
Once the recording is started, you would complete the steps in a way, you would normally enter data into the screens. The highlighter mode ensures that you are capturing the correct parts on the screen. When you are done recording, you are given the option to edit this guide. The Editor then opens up with the guide and the Author can add help content for the recorded fields.
The Author can do the following
-
Add Help Text for each recorded field that they need to see in the final guide. The help text can be customized to different fonts and colors; content like images, links; and links to different guides as well.
-
Rename screens and fields to what they want the end users to see in the guide outline
-
Add/Delete fields and screens
-
Assign to groups and users
-
Change language, applications, technical information etc.
Running a guide
Once a guide is shown to a user in the Knowledge Hub, they can click on the guide to run it. The guide shows the help object next to the field for which this help was recorded and a guide outline that outlines the path this guide will follow, as well as the progress made so far by the user
The help object
The guide outline
Once the guide has finished running, the user will be asked for feedback on the guide they just finished or had to stop prematurely. This is an effective tool to get feedback from the end users and make adjustments. The author can access feedback provided on his guide and can make corrections