RE: Documenting "touchy" applications?

Subject: RE: Documenting "touchy" applications?
From: John Posada <jposada01 -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 18 Mar 2002 11:33:13 -0800 (PST)

--- 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.

=====
John Posada, Senior Technical Writer
Current gig ending 4/15
Resume: http://www.tdandw.com/Resume_Posada_022202.doc
mailto:john -at- tdandw -dot- com, 732-259-2874

__________________________________________________
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

Check out the TECHWR-L Site redesign!
http://www.raycomm.com/techwhirl/

---
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.


References:
RE: Documenting "touchy" applications?: From: Sarah Kampman

Previous by Author: Re: Documenting "touchy" applications? (take II)
Next by Author: Re: Seeking feedback on Picayune Footer nit
Previous by Thread: RE: Documenting "touchy" applications?
Next by Thread: Preparing a bodr


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads