Common Best Practices
  • 21 Feb 2024
  • 2 Minutes To Read
  • Dark
  • PDF

Common Best Practices

  • Dark
  • PDF

Article summary

Always test content in your development environment

If you work in multiple environments, it’s a good practice to publish your content on your test/development environment before deploying it in production.
Test everything2

Organize content using Tags

Adding relevant Tags is a great way to keep your guides accessible and easy to find for other content creators.
Tag content11

For more information, see Tags as Visibility Rules.

Display specific content to users across all roles

To ensure specific content is visible to users across all roles, you must create a Global Role Tag and apply it to all content. This Global Role tag can be based on a condition that is always satisfied, such as checking if the URL contains "com" or "in". Applying this tag to all content, ensures that the content is visible to all users, regardless of their roles, as this condition holds true on every page for all users.

For more information on how to create Role Tag, see Create Role or Page based Tags.

Use contrasting colors for Whatfix widgets

Use contrasting colors for Whatfix widgets, to make them stand out/noticeable on the website. Make sure that your widgets are not lost on your interface.

Use the contrast checker available on this site to help you decide -
Contrast color2

Be clear and concise

Use words and simple sentences. Keep the description in your tooltips simple and to the point.
Description simple.png

Use Beacons to catch the attention of your users

Use Beacons to highlight new features and UI changes. Link Flows to beacons in case there is an associated procedure.
Beacon new ui

For more information, see Create a beacon.

Don't exceed the maximum width in a Tooltip or Pop-up

When inserting images in your content, ensure that they don't exceed the width of the tooltip or pop-up to avoid any distorted images.
distorted image2

Monitor the content performance using Whatfix Analytics

Remember to configure Whatfix Analytics to find out how your content is faring. Are your users completing tasks? Which step are they getting stuck at? What search terms do not give any results? You can track this data and use it to improve the performance of your content.

Use Control+Shift+V to copy and paste content while translating

When translating content in the UI, avoid copy-pasting content. The formatting of the content could get copied and may generate sync issues. If you have to copy and paste, use the CTRL+SHIFT+V (Windows) or COMMAND+SHIFT+V (Mac) to paste content. These shortcuts copy only the value.
Copy paste

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.