Errors, warnings and notifications¶
General rules for messaging¶
- Three parts of a message: 1. title 2. explanation 3. action
- Title: Name which information or problem may/will occur
- Explanation: Give a clear reason for the (potential) error and explain it’s consequences if the user ignores it
- Action: Add clear instructions telling the user what to do next to resolve the error
- Avoid 'Try again' and 'Contact administrator' if there is no good chance that this will solve the issue
- Do not blame the user
- Avoid using you and your only use passive voice as an exception
- Do not repeat your message in title and explanation
- Do not over communicate
- Use a polite and encouraging tone
- Keep it short
- If detailed information is required, consider using progressive disclosure button
- Provide specific names, locations and values of the objects involved
- Show urgency through wording, e.g. “immediately” only if there are serious consequences from ignoring messages
Error messages¶
- An error message alerts user of a problem that exists and must be addressed
- Avoid using
errororwarning, as these words are superfluous in most cases
Do's¶
- Form incomplete: Fill in all mandatory fields
- (Input field validation) Invalid email address
- Failed to delete device. Device still in use
- Insufficient access rights: No access rights to delete {{fileName}}. Contact administrator
- Page not found: Check address
- (Input field validation) Max. 255
(Input field validation) Min. 0 - No Internet connection: Check connection and try again
- Failed to upload file: Check source file and try again
- File not found: Check if file is moved
- (Skip title)
- (Input field validation) Max. 30 characters
- (Skip action)
Don'ts¶
- What did you do!?
- The email address you entered does not match the required format. Please enter your email address using the standard format.
- You have failed to delete the device.
- Permission error: To carry out this task, you need more permissions. Contact admin to change permissions.
- Error 404
- Value out of range.
- System error: You're offline. Check your connection and try again.
- File error: We cannot upload this file. Try uploading again.
- File not found.
- (Title) Input error
- (Explanation) Input error detected.
- (Action) Try again.
Warning messages¶
- A warning message alerts users of a condition that may cause a problem in the future
Do's¶
- Title: Unsaved documents
- Explanation: Save all documents before leaving the app
- Action: Save all (button)
Notifications¶
- Notifications are informative and no actions are required from the user
- Avoid using
success,successful, orsuccessfully, as these words are superfluous in most cases - Avoid using
informationas a title, as it does not provide an additional value to the user
Do's¶
- Access point 2 connected
- Changes saved automatically
- Email sent
Don'ts¶
- Access point connection failed. Try again
- No rows to show
- Email sent successfully
Except where otherwise noted, content on this site is licensed under MIT License.