Message Standards

Messages

Key Guidance for All Messages

Standard

Recommended Example

Not Recommended

Additional Information / Standards

Standard

Recommended Example

Not Recommended

Additional Information / Standards

Avoid words like sorry and please.

Check the data you entered.

Unable to create project.

Please check the data you entered.

Sorry, project creation failed.

Exception

Use sorry for messages that appear directly on the UI when there is a system failure for no fault of the user.

Example: Unable to load annotations. We apologize for the inconvenience.

Avoid jargon, upper-case words, and exclamation marks.

Network Error

The network connection is lost.

NETWORK ERROR!

The operation couldn’t be completed.

(WEGeneralNetworkError error 500.)

Don’t SCREAM at the user!

Do not blame the user.

You must enter a name.

You did not enter a name.

 

Speak directly to the user.

Retry using a unique project name.

All project names must be unique.

 

Use complete names for third-party tools.

Google Chrome

Microsoft Excel

Chrome

Excel

 

Error Messages

Error messages must contain the following elements:

Element

Description

Examples

Additional Information / Standards

Element

Description

Examples

Additional Information / Standards

Description (Optional)

Describes what went wrong or offers details on what went wrong.

Use this only when the description offers information that is not already covered in the error title.

Unable to append Record No. 12335 to Folder ABCDE.

Unable to assign {CostName} costs to {TaskName} task using the {DistributionRuleName} distribution rule.

  • Limit to less than 150 characters.

  • End with a period.

Reason

Explains why the error occurred. This is also where you educate the user.

The project name already exists.

{CostName} is an unaccounted cost. You cannot assign unaccounted costs to project tasks.

  • Limit to less than 150 characters.

  • End with a period.

Resolution

Tells the user what must be done to avoid seeing the message.

Retry using a unique project name.

You must convert {CostName} to an accounted cost and then assign it to {TaskName} task.

  • Limit to less than 150 characters with spaces.

  • End with a period.

Title

Tells the user what went wrong.

Project creation failed

Record addition failed

Cost assignment failed

 

  • Keep it short; less than 50 characters.

  • Use sentence case; no periods.

  • Sacrifice grammar for brevity.

  • Describe only the actual error, not the cause or solution.

Warning Messages

Warning messages inform users of the implications of performing a specific task. Each warning message must contain the following elements:

Element

Description

Examples

Additional Information / Standards

Element

Description

Examples

Additional Information / Standards

Title

Warns the user. Most commonly used title for warning messages is: Warning.

Delete record?

  • Appears above the warning description, in bold.

  • Sentence case; no period in the end, unless the title is a question.

  • Short, scannable: Ideally, 1-3 words.

  • Sacrifice grammar for brevity.

Description

A message that informs the users of the implications of performing a specific task.

This action cannot be undone. Once you delete this record, it will no longer be available.

  • If the warning message has a title as described in the above example, do not start off with an “Are you sure you want to…” It’s covered in the title.

  • If the warning title just says Warning, then:

    • Ask the question; but briefly.

    • Period at the end, if it is a statement; question mark otherwise.

  • Focus on the implications of the action being performed.

  • Max chars: 150.

Option Buttons

The choices that the user has. These can be a simple Yes/No; but it’s better if we are more specific in the options we offer users.

  • Delete

  • Cancel Deletion

  • Use title case.

  • Short imperative sentences. No periods.

  • Max chars: 20.

Confirmation (Toast) Messages

Element

Description

Examples

Additional Information / Standards

Element

Description

Examples

Additional Information / Standards

Message

Conveys the result of an action to the user.

  • Changes saved.

  • Alert deleted.

  • Use complete sentences.

  • Avoid jargon.

  • Toasts should appear at either the top or the bottom of the screen, and should not be the focus.

  • Ideally, toast messages should appear at a consistent location across the application.

  • Avoid adverbs.
    Project created. (INSTEAD OF) Project created successfully.