Skip to main content

Best practices

Transitional text to show something is happening

  • Use -ing verbs and ellipses (…)

  • Do not use informal, transitional wording

  • Confirmation messages: Use the same verb as the transitional text

Updating user roles…
Getting ready…
Submitting log files…
Chopping fruit…
Saving project… > Project saved
Saving project… > Project uploaded
Training models… > Models trained
Training models… > Training done

Error messages

  • Add a clear reason for the error

  • Do not blame the user

  • Add clear instructions for the user regarding what to do next to resolve the error

  • Do not over communicate

  • Use … to show an action is required, i.e. fill this in …

System error: You’re offline. Check your connection and try again.
File error: We cannot upload this file. Try uploading again.
Permission error: To carry out this task, you need more permissions. Contact admin to change permissions.
What did you do!?
The email address you entered does not match the required format. Please enter your email address using the standard format.

Empty-state text

  • Empty-state wording tells the user the empty space is intentional and should be there, i.e. not an error

  • Use wording to move the user forward

  • Use wording to help users understand the function of the empty state

  • Do not over communicate

  • Use wording to show users how to resolve the empty state, e.g. with an action, click, etc.

Allocate users in User management.
No allocated users.
To show rows, select a project.
No rows to show.
To save a project, select Save in Project detail list.
No projects saved.

Restoring behavior of items

  • Be clear on deleting, removing, creating and adding

  • Create goes hand in hand with Delete, it usually means it cannot be restored

  • Add goes hand in hand with Remove, it usually means it can be restored

  • Do not use Delete and Remove as synonym

Create a chart and delete a chart
Create a chart and remove it
Add a sensor to a chart and remove a sensor from chart
Add a sensor and delete the sensor