Course summary
Stay organized with collections
Save and categorize content based on your preferences.
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 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 2022-08-01 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]