Flow Best Practices

Use Flows for sequential actions, such as Product Tours, Tutorials, and UI guidance.

Name each Flow clearly for easy retrieval during searches. Use simple descriptive words that the audience is likely to use. Keep the title short.

Avoid using special characters when naming a Flow, as they may cause issues when downloading the Flow as a video.
If the Flow title includes spaces or any of the following special characters (<, >, :, ", /, |, ,, ?, *, #, %, \s, \n, .), they are replaced with an underscore (_) when the Flow is downloaded as a PDF or a Video.

Provide easy-to-understand words and simple sentences in tooltips. Keep the description concise and to the point.

Create Flows on a stable desktop application that is not constantly updated by code changes. If the underlying code of the application changes, it may break any created Flows.

Limit the number of steps in a Whatfix guide to no more than 15. This enables users to understand the value proposition of the guides quickly and easily.

If the number of steps exceeds 15, consider splitting the guide into two and interlinking them. This keeps the guide crisp and simplifies user tasks.

When interlinking content, ensure that the button in the end message linking to the remaining procedure has an appropriate title. 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 Tooltips to avoid hiding any elements on the desktop application. In certain cases, Tooltips may inadvertently obscure important UI.

Remove personal and 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 direct the user’s complete focus to the element where the tip is displayed. Users cannot interact with other elements while the Spotlight tip is active.

When inserting images in content, ensure they do not exceed the width of the Tooltip. Exceeding 270 pixels introduces a scroll bar.