Course summary
This course recommended the following best practices when writing
error messages:
- Identify the cause of the error.
- If the user entered an invalid value, specify the invalid value.
- Specify requirements and constraints, such as required permissions
or minimum RAM.
- Explain how to fix the problem.
- When appropriate, provide an example to help demonstrate the fix.
- Write clearly.
- Be concise, not wordy. However, don't be so concise that the resulting
error message becomes cryptic.
- Avoid double negatives and exceptions to exceptions.
- Aim the message at the appropriate target audience. Words appropriate
for software engineers are often inappropriate for non-technical users.
- Use terminology consistently. For example, don't use the term directory
in one part of an error message and a folder in another part.
- Format long error messages carefully, possibly using progressive
disclosure or links to expanded documentation.
- Set a positive tone.
- Don't be overly apologetic.
Next unit: Additional guidelines for back end engineers
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-06 UTC.
[null,null,["Last updated 2024-08-06 UTC."],[[["Error messages should clearly identify the cause of the error, including specific invalid values or unmet requirements."],["Provide clear instructions on how to fix the problem, potentially using examples for better understanding."],["Write concise and understandable messages, using consistent terminology and appropriate language for the target audience."],["Maintain a positive and helpful tone without excessive apologies."]]],["Error messages should identify the cause, including invalid values and constraints. Explain the solution, using examples when helpful. Write clearly by being concise, avoiding double negatives, using consistent terminology, and targeting the appropriate audience. Format long messages well. Maintain a positive tone without being overly apologetic. These best practices are recommended for general error messages.\n"]]
