Re: Documenting "touchy" applications

Subject: Re: Documenting "touchy" applications
From: "Dick Margulis " <margulis -at- mail -dot- fiam -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Sat, 16 Mar 2002 14:53:52 -0500

John,

First, I gotta say, CHECK THE ARCHIVES.

Okay, now that I've gotten that out of my system, this topic was addressed a few months ago, more or less. Someone (maybe you) related an anecdote the punchline of which was, "Oh, you mean I have to do the steps in order?"

I think what you need is a single prominently placed caution to your audience that tells them to follow the procedures exactly as written, in order, and from the screens indicated in the procedures. Otherwise results are unpredictable and may result in inconvenience to the user. Then just give them the correct procedures and point back to the caution note occasionally.

Dick

John Posada asks:


>Is there a balance..a middle of the road approach? How do you guys
>handle this?
>
>

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check it out! Get some cool freebies when you buy RoboHelp! You'll receive
SnagIt screen capture software and a 10% discount voucher for RoboHelp
Consulting. This special offers expires March 29, 2002.
www.ehelp.com/techwr

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

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


Previous by Author: Re: Two questions for single-sourcing practitioners
Next by Author: RE: Two questions for single-sourcing practitioners
Previous by Thread: RE: How are technical writers perceived?
Next by Thread: Re: Documenting "touchy" applications


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

Sponsored Ads


Sponsored Ads