Re: How far do you go?

Subject: Re: How far do you go?
From: "Bill Swallow" <techcommdood -at- gmail -dot- com>
To: "Joanne Grey" <jgrey -at- brocade -dot- com>
Date: Fri, 21 Apr 2006 16:05:28 -0400

> I'm documenting a complex product that requires several--perhaps as many
> as half--of the preconfiguration steps to be performed using one of
> several supported third-party products. Normally, I'd skip documenting
> anything that's outside the actual product and cross-reference the
> third-party docs, but in this case a great deal of information needs to
> be given to the users in order for them to determine the correct
> configuration to define.

Give them the info they need in order to make the judgement calls. If
they need to know how to proceed in a 3rd party tool, refer them to
the 3rd party docs. Unless you want to be supporting each and every
update of each and every 3rd party tool, I suggest avoiding the
"how-to" info in your documentation for those tools and deliver the
"need to know" info for your users to make the correct decisions.

Bill Swallow
HATT List Owner
WWP-Users List Owner
Senior Member STC, TechValley Chapter

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!.

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

How far do you go?: From: Joanne Grey

Previous by Author: Re: Hello & Translation Issues
Next by Author: Re: Friday Fun: What Pet Peeve makes you puke?
Previous by Thread: How far do you go?
Next by Thread: RE: How far do you go?

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

Sponsored Ads