Chapter 6. Use of Text in the GUI

Table of Contents

Error Messages, or, "I'm sorry Dave, I'm afraid I can't do that"
...Ellipses...
Abbreviations, Acronyms, and Contractions, oh my!
Capitalization and Spelling
Use of Fonts
Special Case: The Command Line

Almost without exception, if you are writing a program, you will need to pay at least a little attention to how it uses text. There are, believe it or not, right ways and wrong ways, and while most of the guidelines for text might seem trivial, paying attention to what seem like niggling little details is what sets a good program apart from the rest.

Above all else mentioned in this chapter, use language appropriate for your audience -- most of the time, this means avoiding technical terms -- and be both clear and concise.

Error Messages, or, "I'm sorry Dave, I'm afraid I can't do that"

Perhaps the place where you should use text the most is in error messages. They should appear as seldom as possible because you anticipated and handled as many error conditions as possible and then tried to blow it up real good, right? ;) When your program can't handle a particular error, the error message given to the user should do the following:

  1. Explain what happened in everyday words.
  2. Provide enough information to know what happened without providing details which could confuse the user. For example, if a mail client sends a request to a server for e-mail and the server fails to respond, a way to explain this might be something like "MyMailApp could not check your e-mail. The mail server did not respond when contacted."
  3. Offer suggestions to help the user fix the problem, if possible. Using the above example, one possible suggestion might be "Try checking your Internet connection with your web browser. If your web browser works, the mail server might not be working correctly and you may want to try again later."