Explain the Solution

Explain How To Fix The Problem Provide Examples

Explain How To Fix The Problem

Actionable error messages: Solution should come after explaining the problem.

Examples

❌ Your Browser is not supported.

✅ Your Browser is not supported. Please try Chrome or Microsoft edge.

BY GOOGLE

❌ The client app on your device is no longer supported.

✅ The client app on your device is no longer supported. To update the client app,
click the Update app button.

Provide Examples

Add examples that illustrate how to solve the problem.

Examples

❌ Invalid username

✅ Usernames cannot start with a number, must be all lowercase, must be above 4 characters long and only include the following special characters: _, ~. Example: john_robin.

BY GOOGLE

❌ Do not declare types in the initialization list.

✅ Do not declare types in the initialization list. Use calls instead, such as 'BankAccount(owner, IdNum, openDate)' rather than 'BankAccount(string owner, string IdNum, Date openDate)'

BY GOOGLE

❌ Syntax error on token "||", "if" expected.

✅ Syntax error in the "if" condition.

The condition is missing an outer pair of parentheses. Add a pair of bounding opening and closing parentheses to the condition. For example:

if (a > 10) || (b == 0) # Incorrect

if ((a > 10) || (b == 0)) # Correct

Explain how to fix the problem | Technical Writing | Google for Developers

Create actionable error messages. That is, after explaining the cause of
the problem, explain how to fix the problem.

https://developers.google.com/tech-writing/error-messages/show-fix