Stay organized with collections
Save and categorize content based on your preferences.
This lesson contains recommendations specifically for back-end
software engineers.
Supply error codes
If an error code exists, include it as part of the error message.
Error codes help technical users identify the error and find more
information from an error index or error catalog.
Not recommended
Error: You already own this bucket. Select another name from the
dropdown list.
Recommended
Error 409: You already own this bucket. Select another name from the
dropdown list.
Include an Error Identifier
Engineers parse logs to learn how and why errors occurred; therefore, include
an Error Identifier to help engineers find particular errors more easily.
The Error Identifier should stay constant, even if the textual error message
changes.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-31 UTC."],[[["Back-end software engineers should include error codes in error messages to aid technical users in troubleshooting."],["Error messages should contain a consistent Error Identifier to facilitate easier log parsing and error identification for engineers."],["These recommendations aim to improve the clarity and usability of error messages for both technical users and engineers."]]],["Back-end software engineers should include error codes within error messages to aid technical users in identifying and researching errors. They should also incorporate a constant Error Identifier in logs, enabling engineers to efficiently track specific errors, even if the associated text changes. Error codes and identifiers are crucial for diagnosing issues and providing context in error logs.\n"]]
