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.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

CrossOver 14.1.6 - Run Windows apps on y...
CrossOver can get your Windows productivity applications and PC games up and running on your Mac quickly and easily. CrossOver runs the Windows software that you need on Mac at home, in the office,... Read more
Printopia 2.1.14 - Share Mac printers wi...
Run Printopia on your Mac to share its printers to any capable iPhone, iPad or iPod Touch. Printopia will also add virtual printers, allowing you to save print-outs to your Mac and send to apps.... Read more
Google Drive 1.24 - File backup and shar...
Google Drive is a place where you can create, share, collaborate, and keep all of your stuff. Whether you're working with a friend on a joint research project, planning a wedding with your fiancé, or... Read more
Chromium 45.0.2454.85 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. Version 45.0.2454.85: Note: Does not contain the "... Read more
OmniFocus 2.2.5 - GTD task manager with...
OmniFocus helps you manage your tasks the way that you want, freeing you to focus your attention on the things that matter to you most. Capturing tasks and ideas is always a keyboard shortcut away in... Read more
iFFmpeg 5.7.1 - Convert multimedia files...
iFFmpeg is a graphical front-end for FFmpeg, a command-line tool used to convert multimedia files between formats. The command line instructions can be very hard to master/understand, so iFFmpeg does... Read more
VOX 2.6 - Music player that supports man...
VOX is a beautiful music player that supports many filetypes. The beauty is in its simplicity, yet behind the minimal exterior lies a powerful music player with a ton of features and support for all... Read more
Box Sync 4.0.6567 - Online synchronizati...
Box Sync gives you a hard-drive in the Cloud for online storage. Note: You must first sign up to use Box. What if the files you need are on your laptop -- but you're on the road with your iPhone? No... Read more
Carbon Copy Cloner 4.1.4 - Easy-to-use b...
Carbon Copy Cloner backups are better than ordinary backups. Suppose the unthinkable happens while you're under deadline to finish a project: your Mac is unresponsive and all you hear is an ominous,... Read more
OmniGraffle Pro 6.3.1 - Create diagrams,...
OmniGraffle Pro helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use... Read more

Rock(s) Rider - HD Edition (Games)
Rock(s) Rider - HD Edition 1.0.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.0 (iTunes) Description: *** PLEASE NOTE: Compatible with iPhone 4s, iPad 2, iPad mini, iPod touch (5th generation) or newer *** Do you... | Read more »
Rebuild 3: Gangs of Deadsville (Games)
Rebuild 3: Gangs of Deadsville 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: It's been a few years since the zombpocalypse turned the world's cities into graveyards and sent the few... | Read more »
Power Ping Pong (Games)
Power Ping Pong 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Do you wield your bat with zen-like focus or do your balls of fury give you a killer spin? Table tennis goes mobile with a... | Read more »
Z.O.N.A Project X (Games)
Z.O.N.A Project X 1.00 Device: iOS Universal Category: Games Price: $1.99, Version: 1.00 (iTunes) Description: Z.O.N.A Project X - shooter in the post-apocalyptic world. | Read more »
Trick Shot (Games)
Trick Shot 1.0.6 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0.6 (iTunes) Description: A game where all you have to do is throw a ball into a box, simple? Trick Shot is a minimalist physics puzzler with 90 levels... | Read more »
Goat Simulator MMO Simulator (Games)
Goat Simulator MMO Simulator 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: ** IMPORTANT - SUPPORTED DEVICESiPhone 4S, iPad 2, iPod Touch 5 or better.** Coffee Stain Studios brings next-gen... | Read more »
Worms™ 4 (Games)
Worms™ 4 1.02 Device: iOS Universal Category: Games Price: $4.99, Version: 1.02 (iTunes) Description: The latest instalment in the worldwide mega hit franchise! Coming soon to iPhone, iPad and iPod touch. When the guys and girls at... | Read more »
The Deer God (Games)
The Deer God 1.0 Device: iOS Universal Category: Games Price: $6.99, Version: 1.0 (iTunes) Description: 30% off launch sale!!! “It can be a struggle, but it's all worth it when you're shooting fire out your antlers.” Kotaku “The... | Read more »
AppSpy's Patreon campaign kicks off
Occasionally you'll see us use AppSpy's videos here on 148Apps to support an article we've written. That's because we're part of Steel Media, and AppSpy is Steel's video arm, so we're all part of one happy family. [Read more] | Read more »
We're Sorry to Report that Moonrise...
Moonrise is a very promising-looking, Pokemon-esque monster collecting and battling game that we were really looking forward to reviewing, but unfortunately it looks like that's never going to happen. [Read more] | Read more »

Price Scanner via MacPrices.net

Will You Buy An iPad Pro? – The ‘Book Mystiqu...
It looks like we may not have to wait much longer to see what finally materializes as a new, larger-panel iPad (Pro/Plus?) Usually reliable Apple product prognosticator KGI Securities analyst Ming-... Read more
eFileCabinet Announces SMB Document Managemen...
Electronic document management (EDM) eFileCabinet, Inc., a hosted solutions provider for small to medium businesses, has announced that its SecureDrawer and eFileCabinet Online services will be... Read more
WaterField Designs Unveils American-Made, All...
San Francisco’s WaterField Designs today unveiled their all-leather Cozmo 2.0 — an elegant attach laptop bag with carefully-designed features to suit any business environment. The Cozmo 2.0 is... Read more
Apple’s 2015 Back to School promotion: Free B...
Purchase a new Mac or iPad 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,... Read more
128GB MacBook Airs on sale for $100 off MSRP,...
B&H Photo has 11″ & 13″ MacBook Airs with 128GB SSDs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 11″ 1.6GHz/128GB MacBook Air: $799.99, $100 off MSRP... Read more
13-inch 2.5GHz MacBook Pro (refurbished) avai...
The Apple Store has Apple Certified Refurbished 13″ 2.5GHz MacBook Pros available for $829, or $270 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.... Read more
27-inch 3.2GHz iMac on sale for $1679, save $...
B&H Photo has the 27″ 3.2GHz iMac on sale for $1679.99 including free shipping plus NY sales tax only. Their price is $120 off MSRP. Read more
Apple and Cisco Partner to Deliver Fast-Lane...
Apple and Cisco have announced a partnership to create a “fast lane” for iOS business users by optimizing Cisco networks for iOS devices and apps. The alliance integrates iPhone with Cisco enterprise... Read more
Apple offering refurbished 2015 13-inch Retin...
The Apple Store is offering Apple Certified Refurbished 2015 13″ Retina MacBook Pros for up to $270 (15%) off the cost of new models. An Apple one-year warranty is included with each model, and... Read more
Apple refurbished 2015 MacBook Airs available...
The Apple Store has Apple Certified Refurbished 2015 11″ and 13″ MacBook Airs (the latest models), available for up to $180 off the cost of new models. An Apple one-year warranty is included with... Read more

Jobs Board

*Apple* Desktop Analyst - KDS Staffing (Unit...
…field and consistent professional recruiting achievement. Job Description: Title: Apple Desktop AnalystPosition Type: Full-time PermanentLocation: White Plains, NYHot Read more
Simply Mac *Apple* Specialist- Repair Techn...
Simply Mac is the greatest premier retailer of Apple products expertise in North America. We're looking for dedicated individuals to provide personalized service and Read more
Simply Mac *Apple* Specialist- Service Repa...
Simply Mac is the greatest premier retailer of Apple products expertise in North America. We're looking for dedicated individuals to provide personalized service and Read more
*Apple* Desktop Analyst - KDS Staffing (Unit...
…field and consistent professional recruiting achievement. Job Description: Title: Apple Desktop AnalystPosition Type: Full-time PermanentLocation: White Plains, NYHot Read more
Simply Mac- *Apple* Specialist- Store Manag...
Simply Mac is the largest premier retailer for Apple products and solutions. We're looking for dedicated individuals with a passion to simplify and enhance the Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.