RE: Documenting "touchy" applications?

Subject: RE: Documenting "touchy" applications?
From: "Sarah Kampman" <skampman -at- acornsys -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 18 Mar 2002 13:18:26 -0600

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 Troubleshooting
chapter also provides a single, logical place to say: "well, you seem to
have noticed that our app is moody. here's why, here's the underlying logic,
and here's how to deal with it."

In any case, I don't envy you. Good luck!

-Sarah Kampman
skampman -at- acornsys -dot- 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
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 for more resources and info.


Re: Documenting "touchy" applications? (take II): From: John Posada

Previous by Author: RE: Now lone techwriter, startup
Next by Author: RE: tracking writer progress on tight deadline?
Previous by Thread: Re: Documenting "touchy" applications? (take II)
Next by Thread: RE: Documenting "touchy" applications?

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

Sponsored Ads