TweetFollow Us on Twitter

Dec 01 Cover Story

Volume Number: 17 (2001)
Issue Number: 12
Column Tag: Cover Story

by G.D. Warner

Error Messages: The Good, The Bad, And The Ugly

Writing Error Messages That Don’t Make Your Users Feel Stupid

“You are in error. You are a biological unit. You are imperfect.”

As error messages go, that quote from the original Star Trek episode, “The Changeling” is — well, actually kinda scary, considering what happened in that episode (Nomad, remember? A small robot that destroyed planets for fun — because that planet’s inhabitants were, in Nomad,’s “eyes,” imperfect).

While I’m sure RB developers don’t write error messages like that — and, coupled with REAL Software’s failure to insert a “Smite” command into the IDE makes carrying out the implied threat difficult, at best — I wanted to take this opportunity to run through, as the title says, ‘The Good, The Bad, and The Ugly’ of error messages.

The British magazine, MacFormat (which some would say is the British version of MacAddict, though in fact the reverse is true) has a section devoted to bad error messages, entitled “Silly Things Your Mac Says.” Alas, MacFormat’s web presence (http://www.macformat.co.uk) is not quite as strong as that of MacAddict’s (http://www.macaddict.com), so I’m afraid I can’t refer you to a page to view them all. Sorry abut that!

(Initiate Twilight Zone mode: que creepy music, Dim Rod Serling voice as True:)

Consider, if you will, the typical new computer user. S/he has just enrolled in the Computers For Dummies class at her local community college — using Windows ‘00 (pronounced “uh-oh,” in case you were wondering) as the Training Platform of Choice. Everything goes well in the class that first week (remember, we’re using our imaginations, here), and our new computer user finishes that first week, and goes out and buys her own computer.

And gets her first error message. The horror begins (see Figure 1).


Figure 1. Thanks a Lot (End Twilight Zone mode).

Alan Cooper, in his book About Face: The Essentials of User Interface Design, writes: “This is what all error messages feel like to users… No matter how nicely your error messages are worded, this is how they will be interpreted.”

But what makes a good error message?

The Microsoft Manual of Style, Second Edition, provides pointers for writing error messages:

“When you write error messages, use the passive voice to describe the error, and, if necessary, the third person (refer to ‘he computer’ or ‘the program’). You can also blame the product. Addressing the user directly as ‘you’ may imply that the user caused the problem. Try to make error messages friendly, direct, and helpful.”

Apple’s Aqua Human Interface Guidelines tells us:

“A good alert message states clearly what caused the alert to appear and what the user can do about it. Express everything in the user’s vocabulary.”

This is good advice … but Alan Cooper says it a bit better:

“Don’t make the user look stupid.”

Mr. Cooper later provides another interesting example of how error messages shouldn’t be written, reproduced here as Figure 2:


Figure 2. What the —!?

What would go through your mind if the above error message were to show up on your screen? Probably something similar to what Mr. Cooper wrote:

“Thank you so much for sharing that pithy observation with us. Why didn’t you notify the library? What did you want to notify it about? Why are you telling me? What do I care? Maybe you’d like to comment on what I’m wearing, too? And besides, what am I ‘OK’ing? It is not OK with me that this failure occurred!”

Couldn’t have said it better myself.

To reiterate Apple’s recommendations:

  • Tell the user what happened
  • Tell the user how to fix whatever is wrong
  • Tell the user what happened in their own vocabulary

This last one is particularly important: if your error message says something like “PrntSvrErr in Serial/USB port,” your user is most likely going to be confused by “PrntSvrErr.” Why not simply write “Printer Server Error,” if indeed that’s what it means?

The Good

There aren’t a lot of good examples out there… but I did find a few that come close. Take Figure 3 for example:


Figure 3. Example of a Good Error message.

This error message follows the basic guidelines of a good error message:

It tells the user what’s wrong (more or less)

It offers a fix

It delivers its message in plain language Figure 4, from Apple’s Aqua Human Interface Guidelines gets the job done:


Figure 4. Another Good Error Message.

It tells the user what’s wrong — and why

It offers not one, but two possible fixes

It delivers its message in plain language

The error message shown in Figure 5 seems to have done it correctly:


Figure 5. Another Good Error Message.
  • It tells the user what’s wrong — and why
  • It offers not one, not two, but three possible fixes — and includes a phone number for Tech Support
  • It delivers its message in plain language

By all rights, this should be the best of the best — but my technical writer instincts tell me it’s far too wordy. A user faced with this error message would most likely not bother to read it (“Too much information, too much information!”), then just click OK.

The Bad

It’s far easier to find examples of bad error messages than good ones… and a lot more fun! So here we go. Figure 6 is from an early version of Netscape:


Figure 6. Bad Error, Netscape Style.

In his article “Why You Can’t Run Java,” Mark Hurst said…well, basically he said that this error message might be difficult for most users to understand (yeah… that’s it!).

Another, shall we say, somewhat-less-than-useful error message is shown in Figure 7:


Figure 7. Really Bad Error Message.

I wonder what happened here? — Oh, yeah. “Some sort of error.” Obviously.

You’ve probably seen or heard about the e-mail that circulated some time back with error messages written in Haiku, the ancient Japanese form of poetry. For those of you who don’t know (or dozed off a lot during the poetry section of your English classes), Haiku has only three rules:

Three lines only

First and last lines are to be no more than three syllables

Second line consists of no more than seven syllables

Here’s one:

Three things are certain:
Death, taxes, and lost data.
Guess which has occurred.

I’ve placed the URL in the Reference section so you can read the rest… but if you can’t wait, fire up a computer running the BeOS, load up Be’s web browser, NetPositive, and type in a URL without being connected to a network … and see what you get.

Hopefully, you’ll get something like Figure 8:


Figure 8. NetPositive Haiku.

Uh-oh… I feel inspiration beating me about the head and shoulders!

In NetPositive
It is quite easy to find
Poetic Errors

(Sorry about that.)

Someone who identifies himself as “Johnnie Favorite” or “Happy Mega Fighting Man,” and a former Be employee tells me this feature can be turned off in one of the NetPositive settings.

I’ll get to that … one of these days.

Not to be outdone, a few Apple developers at Dantz have written a few of these (at least for early versions of the Retrospect manual) as shown in Figure 9 (thanks to ResExcellence.com):


Figure 9. Dantz Retrospect’s Haiku Error Message.

The Ugly

Not a lot of screenshots for this category, as some of these are Unix/Linux error messages, passed on by Word of Mouth. My favorite:

Printer on fire. See the Reference section for a link for more info on this one…

A close second, from Linux fsck (the Linux version of “Scandisk”):

“Either there is a bug in fsck or some bonehead (you!) is checking a live filesystem. Please report bugs in fsck to .”

‘Tacit’ writes in comp.lang.basic.realbasic:

“For the worst error messages ever written by God or man, I suggest you take a look at Windows 2000. It has some error messages you absolutely will not believe.

‘Attempt to propogate SUIDs across Active Directory failed with code 1602.’

“In English, this means: ‘You have special permissions set for a user who does not exist.’”

Interesting . . .

This error message uses error codes. Opinions on these are mixed: Some like them, some hate them… but they do have their uses.

Using that error code, a developer can track the number of times a particular error is displayed, compare it to other errors that report error codes, and from there decide which one to fix first.

MT-NewsWatcher uses similar error codes in some of its error messages, as shown in Figure 10:


Figure 10. MT-NewsWatcher Error with Error Code.

Tool Tips, the Balloon Help on the Windows side of things, is also something one needs to be careful of. The tool tip shown in Figure 11 cost a developer his job:


Figure 11. One Way Ticket Out the Door for this developer.

Here’s an interesting one, from Free Java:


Figure 12. Let’s Get Biblical.

I wonder if Free Java has a ‘Smite’ command…? Hmmmm …

And then, of course, there’s these:


Figure 13. Dude! (Welcome).


Figure 14. Dude —! (Okay).


Figure 15. Dude —! (Toast).

While it is true that a skilled linguist could probably differentiate between “Dude—!” as an expression of agreement, and “Dude—!” as a warning message, relying on this ability for your error messages is probably not a good idea … so the less said about the “Dude” family of error messages, the better.

In fact, forget I mentioned it, okay?

Okay. So What?

Good question. How about this quote:

“Nothing says more about what you think of your users than error messages.”

This quote, from Scott Berkun’s article, “The Web Shouldn’t be a Comedy of Errors,” really says it all. If it doesn’t ‘say it all’ to you, he follows up with a discussion of some excellent software engineering ideas on handling errors (see Scott Berkun in the Reference section … and take another look at Figure 11).

Like in one of the Karate Kid movies (“Kid? I’m thirty-five!”), when Mr. Miyagi describes the best way to block a punch by the ‘simple’ method of “No be there when punch arrive,” Scott’s article recommends designing your program so that it has fewer chances for your users to require an error message.

Chuck Martin, a posting to the Tech Writer’s list agrees. “…design, as much as possible, the interface so users can’t make errors, or at least will have a more difficult time making errors.”

For instance, a field that requires numerical input should screen out alphabetical characters, as illustrated in this code snippet (KeyDown event of an Edit field):

Listing 1: ASCII Only, Please

Disables non-numerical keystrokes in an edit field.

Function KeyDown(Key As String) As Boolean
 If (ASC(key) < 48) Or (ASC(key) > 57) Then
  If (ASC(key) = 8) Or ((ASC(key) >= 28) And (Asc(key) <= 31)) Then
   Return False
  Else
   Return True
  End If
 Else
  Return False
 End If
End Function

This kills the need for an error message that reads “Dumbkopf! Numbers ONLY in this field!” or something similar.

Another thing to consider (with some applications, anyway): disabling the ‘Okay’ or ‘Submit’ button until all required fields are filled in. This avoids the “You idiot! You forgot to type in your fax number!” error message — when your user doesn’t have a fax number to enter, and simply hits the Okay button, thinking s/he’s finished entering data.

Robert Heath, another member of the Tech Writer’s list (see the Reference section) says, “My own peeve is messages with exclamation points. ‘You must enter a date!,’ etc.

Wrapping Up

In this article, we’ve taken a look at what makes a good error message, what makes a bad error message, touched on some ‘ugly’ error messages, skimmed the surface of software design methodology, and dipped a metaphorical toe into the waters of user interface design. Hopefully, we’ve all learned something along the way… but there’s only one way to be sure! A quiz. Your question — for the grand prize of a bag of pre-cooked microwave popcorn, mailed to your house by our own managing editor, Jessica Stubblefield (first come, first served, no guarantees on how well cooked the popcorn will be):

If your user is trying to print but can’t, is it better to display an error message that reads —

A. “Failed to initialize printer port [OK},”
B. “Having trouble printing. Ensure the printer is connected to your computer and that the power cord is securely connected and press the ‘Retry’ button. {Retry} {Cancel}”

“Printer on fire! Get out now!! {Okay}”

“DUDE!!! {Okay}”

If you answered A, congratulations! Your users will hate you, and you are well on your way to becoming as infamous as the person that wrote that immortal phrase, “Someone put us the bomb.” Or perhaps the other immortal phrase, “All your base are belong to us.”

If you answered B, congratulations! Your users will love you, and actually pay for your shareware.

If you answered C, congratulations! You’re doomed to a lifetime of answering the telephone support lines for the software you wrote, which caused the printer to catch fire in the first place. Your days will be long (15 hours!) and you’ll only get minimum wage — unlike your fellow tech support-folk, who support applications written by the guy whose error messages read like those in answer B. These guys get more money because their developer gets paid for his software.

If you answered D … um … well, the less said about that the better!

You’re educated
Put away this magazine
And go code something.

Heh.

Bibliography and References

Haiku Error Messages:

“Printer On Fire” Error Messages:

‘Linux FSCK’ Error Message:

Just For Laughs . . .


G.D. Warner is a technical writer, a Web-Dev Ninja-In-Training, and resides in Seattle, where the Shadow of Redmond looms long and large. He can be reached at gdwarner@mac.com.

 
AAPL
$519.01
Apple Inc.
+1.05
MSFT
$40.40
Microsoft Corpora
+0.65
GOOG
$556.54
Google Inc.
+20.10

MacTech Search:
Community Search:

Software Updates via MacUpdate

PDFpenPro 6.2 - Advanced PDF toolkit for...
PDFpenPro allows users to edit PDF's easily. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Even correct text and edit graphics! Create... Read more
PDFpen 6.2 - Edit and annotate PDFs with...
PDFpen allows users to easily edit PDF's. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Even correct text and edit graphics! Features... Read more
Monolingual 1.5.9 - Remove unwanted OS X...
Monolingual is a program for removing unnecesary language resources from OS X, in order to reclaim several hundred megabytes of disk space. It requires a 64-bit capable Intel-based Mac and at least... Read more
Maya 2015 - Professional 3D modeling and...
Maya is an award-winning software and powerful, integrated 3D modeling, animation, visual effects, and rendering solution. Because Maya is based on an open architecture, all your work can be scripted... Read more
Starcraft II: Wings of Liberty 1.1.1.180...
Download the patch by launching the Starcraft II game and downloading it through the Battle.net connection within the app. Starcraft II: Wings of Liberty is a strategy game played in real-time. You... Read more
Sibelius 7.5.0 - Music notation solution...
Sibelius is the world's best-selling music notation software for Mac. It is as intuitive to use as a pen, yet so powerful that it does most things in less than the blink of an eye. The demo includes... Read more
Typinator 5.9 - Speedy and reliable text...
Typinator turbo-charges your typing productivity. Type a little. Typinator does the rest. We've all faced projects that require repetitive typing tasks. With Typinator, you can store commonly used... Read more
MYStuff Pro 2.0.16 - Create inventories...
MYStuff Pro is the most flexible way to create detail-rich inventories for your home or small business. Add items to MYStuff by dragging and dropping existing information, uploading new images, or... Read more
TurboTax 2013.r17.002 - Manage your 2013...
TurboTax guides you through your tax return step by step, does all the calculations, and checks your return for errors and overlooked deductions. It lets you file your return electronically to get... Read more
TrailRunner 3.8.769 - Route planning for...
Note: While the software is classified as freeware, it is actually donationware. Please consider making a donation to help support development. TrailRunner is the perfect companion for runners,... Read more

Latest Forum Discussions

See All

Unpossible (Games)
Unpossible 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: **Important** Requires at least iPad 2, iPhone 4S, iPod Touch (5th gen), or newer. | Read more »
Hitman GO (Games)
Hitman GO 1.2 Device: iOS Universal Category: Games Price: $4.99, Version: 1.2 (iTunes) Description: Get your daily fix of Agent 47 with this elegant, strategy-based Hitman game! | Read more »
The Seventh Sign: Hodappy Bird Released...
The Seventh Sign: Hodappy Bird Released on the App Store Posted by Jeff Scott on April 16th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Rogue Heroes (Games)
Rogue Heroes 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Rogue Heroes is awesome fast-paced 2D action-platforming roguelike game with RPG elements. - explore the depth of procedurally... | Read more »
Fourcast Review
Fourcast Review By Jennifer Allen on April 16th, 2014 Our Rating: :: VIDEO POTENTIALiPhone App - Designed for the iPhone, compatible with the iPad Fourcast is a great idea for combining video clips, but it does lack a number of... | Read more »
Hearthstone: Heroes of Warcraft is Avail...
Hearthstone: Heroes of Warcraft is Available on the U.S. App Store Right Now – Gogogogo! Posted by Rob Rich on April 16th, 2014 [ permalink ] | Read more »
Grammar Pop HD Review
Grammar Pop HD Review By Jennifer Allen on April 16th, 2014 Our Rating: :: FUN LEARNINGiPad Only App - Designed for the iPad Learning the different parts of speech isn’t always fun, but Grammar Pop HD makes it much more... | Read more »
Groundskeeper2 Review
Groundskeeper2 Review By Nadia Oxford on April 16th, 2014 Our Rating: :: SLICE THOSE ALIEN SLIMEUniversal App - Designed for iPhone and iPad Putting aside some minor control issues, Groundskeeper2 is a fun and furious action/... | Read more »
Pinnacle Studio for iPhone (Photography...
Pinnacle Studio for iPhone 5.0 Device: iOS iPhone Category: Photography Price: $9.99, Version: 5.0 (iTunes) Description: | Read more »
Season 3 of Zombies, Run! Starts Right N...
Season 3 of Zombies, Run! | Read more »

Price Scanner via MacPrices.net

Microsoft Blinks – Drops Microsoft Office 365...
Microsoft has dropped the annual subscription fee for Microsoft Office 365 Personal – which is needed in order to create and edit documents in Microsoft Office for iPad. However, Apple’s iOS and OS X... Read more
New AVG Vault Apps for iOS and Android Help K...
AVG Technologies N.V. an online security company for 177 million active users, has announced the launch of its latest mobile application, AVG Vault. The free app introduces an innovative user... Read more
Free Local Carrot iPhone App Helps Find Fresh...
I love fresh vegetables. I’m not a vegan, although I was for several years in the 1980s, but fresh vegetables and other whole foods are still my dietary mainstays as a matter of taste rather than... Read more
Apple refurbished iPad Airs available startin...
Apple is now offering Certified Refurbished iPad Airs for up to $140 off MSRP. Apple’s one-year warranty is included with each model, and shipping is free. The following Airs are available today: -... Read more
21-inch 2.7GHz iMac on sale for $1179, save $...
B&H Photo has the 21″ 2.7GHz iMac on sale for $1179 including free shipping plus NY sales tax only. Their price is $120 off MSRP. Add an iMac to your shopping cart, and B&H will offer an... Read more
Download our app, iTracx, for iOS and Android
MacPrices is proud to offer readers a free iOS app (iPhones, iPads, & iPod touch) and Android app (Google Play and Amazon App Store) called iTracx, which allows you to glance at today’s lowest... Read more
Education discounts shave up to $300 off the...
Purchase a new Mac at The Apple Store for Education and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free, and all... Read more
Save $50 on Mac mini Server
B&H Photo has the 2012 Mac mini Server on sale for $949 including free shipping plus NY sales tax only. Their price is $50 off MSRP. Read more
PhatWare’s “Ultimate Writing App For iOS” Ren...
PhatWare Corp. has announced it has renamed its new WritePro word processing app for iPhone and iPad: WritePad Pro. The decision to change the app’s name to leverages the strong brand awareness and... Read more
Full Resolution Photo Editor Tint Mint 1.0 Re...
California based independent developer, Jeffrey Sun, creator of the iOS app Modern Editor, has released Tint Mint, a new photography app for editing enthusiasts. The app costs a dollar, and it packs... Read more

Jobs Board

*Apple* Retail - Manager - Holyoke - Apple I...
Job Summary Keeping an Apple Store thriving requires a diverse set of leadership skills, and as a Manager, you’re a master of them all. In the store’s fast-paced, Read more
*Apple* Retail - Manager - Apple (United Sta...
Job SummaryKeeping an Apple Store thriving requires a diverse set of leadership skills, and as a Manager, you're a master of them all. In the store's fast-paced, dynamic Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
*Apple* Retail - Market Leader - Cincinnati...
…challenges of developing individuals, building teams, and affecting growth across Apple Stores. You demonstrate successful leadership ability - focusing on excellence Read more
*Apple* Retail - Manager - SoHo - Apple (Uni...
Job SummaryKeeping an Apple Store thriving requires a diverse set of leadership skills, and as a Manager, you're a master of them all. In the store's fast-paced, dynamic Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.