If you’re a technical communicator who’s involved in a software development project from its early stages—the way I think it should be—then you may have some input on error messages and other system feedback that users see in the interface. I spent some time last week editing about 1000 messages for another project, and in doing so I came up with a few guidelines for writing them:
- Give enough information for the user to know what to do next.
- Use terms that the user understands.
- Don’t skimp on words. It’s more important that the message be clear than for it to save space. This even includes articles and related adjectives, like “a,” “the,” and “this.”
- Be consistent with wording and structure. Don’t say “Employee ID can’t be blank” in one place and “The effective date is required” somewhere else.
Related entries (auto-generated):
Usability and Maintainability: Understandable Information
Visualization Can Improve Writing
Clear, Common Language Leads to User Success
Journals by Email











Ben Reply:
March 8th, 2010 at 4:24 pm
That’s funny. The ironic thing is that instead of fix the bug, the developer coded an error message to show up when the bug is encountered. But maybe he did some homework and found that fixing the bug was complicated and costly, and the project manager made the decision to go the cheaper route at least at first. Thanks for the example.
[Reply]