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:

  1. Give enough information for the user to know what to do next.
  2. Use terms that the user understands.
  3. 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.”
  4. 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

Consistency Leads to Trust in Information Sources

First Principles of Technical Writing