Re: Terms not to use in Error Messages
I am looking for a comprehensive list of terms that should not be used in
error messages. If any of you have stumbled on such a list on the
Internet, I request you to share the resource location.
For example, it is recommended not use the word 'illegal', the term
'invalid' must be used instead.
"It is recommended" is a fine example of a passive voice construction we would like to avoid. It's meaning is clearly the same as "they say"; that is, we do not know who is doing the recommending, so we are chary of the recommendation.
The word _illegal_ in error messages usually occurs in "the application has performed an illegal operation." I can tell you that my dad encounters this a lot, and he calls me in a panic, wondering what he has done wrong and whether the computer police are going to knock on his door (he's just old and easily confused, not stupid). I don't know whether substituting the word _invalid_ for _illegal_ solves the problem. My dad might not be worried about the police, but he still would be no further toward understanding what happened or what action he should take next.
I think a more useful message would be one that focuses on the user's needs rather than on the developer's diagnostics, and I believe Windows XP has finally replaced the "illegal operation" language with something friendlier. However, assuming that you are writing error messages for a user interface rather than for an operating system, let's switch to a homelier example.
For example, if you present a form to the user that requires valid entries in fields, the user is going to react better to, "Please enter a valid email address," than to, "You entered an invalid email address."
See where I'm going with this? It isn't a list of words that should drive your message writing but rather a user-centered attitude. The right words will present themselves as you need them.
[This E-mail scanned for viruses at mail.fiam.net]
NEED TO PUBLISH FRAMEMAKER CONTENT ONLINE? "Mustang" is a NEW single
sourcing tool for FrameMaker that lets you easily publish your content
online. No macro language required! http://www.ehelp.com/techwr-l3
Mercer University's online MS Program in Technical Communication Management:
Preparing leaders of tomorrow's technical communication organizations today.
See www.mercer.edu/mstco or write George Hayhoe at hayhoe_g -at- mercer -dot- edu -dot-
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.
Terms not to use in Error Messages: From: Seema
Search our Technical Writing Archives & Magazine