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.
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.
HATT List Owner
WWP-Users List Owner
Senior Member STC, TechValley Chapter http://techcommdood.blogspot.com
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!. http://www.webworks.com/techwr-l