- 25 Jan 2024
- 2 Minutes To Read
-
Print
-
DarkLight
-
PDF
Flow Best Practices
- Updated On 25 Jan 2024
- 2 Minutes To Read
-
Print
-
DarkLight
-
PDF
Use Flows for sequential actions. For example: Product tour, Tutorials, and UI guidance.
Name every Flow clearly for easy retrieval during search. Use simple descriptive words that your audience is likely to use. Keep the title short. Use gerunds.
Do not use special characters when naming a Flow. Special characters may cause issues when trying to download the Flow as a video.
If the Flow title includes spaces or any of these special characters (<,>,:,",/,|,,?,*,#,%,\s,\n,.), then they are replaced with an underscore (_) when the flow is downloaded as a PDF or a Video.
Use easy to understand words and simple sentences. Keep the description in your tip simple and to the point.
Create Flow on your desktop application which is stable and is not constantly being updated by code changes. If the underlying code of your application is being changed, it may break any Flows that you may have created.
Limit the number of steps in a Whatfix guide to not more than 15 steps. This helps your users understand the value proposition of your guides quickly and easily.
In case you can't keep the number of steps under 15, then consider splitting the guide into two and interlinking them. This keeps your guide crisp and simplifies user tasks.
When interlinking content, ensure that the button on the end message that links to the remaining procedure is titled appropriately. Use a short, action-oriented phrase.
When interlinking content, ensure that the button on the end message that links to the remaining procedure is titled appropriately. Use a short, action-oriented phrase.
Position the Tooltips so that they don't hide any elements on your desktop application. In certain cases, the Tooltip could inadvertently hide certain important UI.
Remove personal/sensitive information using the Blackout feature. While creating a guide, use the Blackout feature to avoid capturing sensitive information like email, phone number, username, and more.
Use the Spotlight feature to get the user’s complete focus on the element on which the tip is displayed. Users cannot interact with other elements when the Spotlight tip is active.
When inserting images in your content, ensure that they don't exceed the width of the Tooltip. Exceeding 270 pixels introduces a scroll bar.