TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
--- Sarah Kampman <skampman -at- acornsys -dot- com> wrote:
> I work under the theory that users only follow the instructions if
> their
> first guess didn't work. With that in mind, make sure there's a
> good
> Troubleshooting chapter, particularly if each error message is
> unique enough
> to enable you to point the user to the right procedure. A
At the beginning of every document, I have a section called:
"Conventions: Displays, Layout, Navigation, Commands, Formatting,
Prompts, and Messages."
I know, quite a mouthful. However, it is here that if it is an error
message, I show a picture of the message, what caused it, and how to
avoid it. I also include hints on how to avoid errors before they
make themselves known.
__________________________________________________
Do You Yahoo!?
Yahoo! Sports - live college hoops coverage http://sports.yahoo.com/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
PC Magazine gives RoboHelp Office 2002 five stars - a perfect score!
"The ultimate developer's tool for designing help systems. A product
no professional help designer should be without." Check out RoboHelp at http://www.ehelp.com/techwr
---
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.
