Common Best Practices

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

Adding relevant Tags is a great way to keep your guides accessible and easy to find for your users.

Fore more information, see Tags.

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

Use the contrast checker available on this site to help you decide - https://webaim.org/resources/contrastchecker/

Use words and simple sentences. Keep the description in your tip simple and to the point.

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.

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.

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.

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

For more information, see Create a beacon.