Flows Best Practices

Use Flows for sequential actions like product tours, tutorials, and UI guidance.
For more information on creating a Flow, see Create a Flow.

Name each Flow clearly for easy retrieval. Use simple, descriptive words that your audience is likely to use. Keep titles short and avoid special characters.

Avoid special characters when naming a Flow. They can cause issues when downloading the Flow as a video. For more information, see Download 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 simple language and keep the description in your Tooltip concise and to the point.

Create Flows on a stable production or live application. If the underlying code changes frequently, it could break the Flows.

Limit the number of steps in a Whatfix Flow to not more than 15 steps. This enables 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.

Ensure that Tooltips do not obscure important UI elements. Proper positioning prevents user frustration.

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.

Instead of creating individual steps for each field in a form, create Smart Tips that describes each field. This way all you need to create is a single step for the entire form asking the user to interact with the fields to find more information, thus reducing the total steps in the Flow. Also, the users can choose to see the tooltip help only for the fields they need information about,
 rather than seeing info for every field in the Flow steps.

Another benefit is that you can use the Smart Tips to validate user input ensuring the right information is entered. For more information, see Data Validation using Smart Tips

When you have a field/element in an application which do not appear to a certain set of users, configure such steps as Optional to ensure continuity of the Flow.

If the field/element does not appear, the Optional steps are skipped and the Flow continues to the next step. If the field/element is present in the UI, then the Flow progresses as usual. You do not have to create a separate Flow and trigger it based on the appearance of the field/element. For more information, see Define a step as optional.

Use contrasting colors that make the Tooltip noticeable on your website/application. This is to ensure that the Tooltips are not lost in your interface because they can't be distinguished between the underlying application.

For more information on contrast checking, see this contrast checker website that could help you decide.

Use simple words and sentences while creating Whatfix content. Keep the description in your Tooltip brief and to the point.

Choose the best available Tooltip theme to ensure the UI of the Tooltip matches your website/application’s UI.

For more information, see Change the design of the tool tip.

Add an end message to all the Whatfix content to ensure your users are well informed about the next course of action.

For more information on adding an end message, see Customizing the end message of a Flow