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.
At 05:49 AM 03/16/2000 -0800, Chris Hamilton wrote:
>....If you hand a good programmer a well-written user
>guide [written by a competitor company],he can
>probably use it to create a system which would
>otherwise have taken years to put together.
>>Depending on the product, my assumption is that you
>>shouldn't innundate the reader with details about the
>>internals, except on a need-to-know basis.
I'm not talking about inundating the reader with details. IMHO, a really
well-written user guide will walk the user through every aspect he'll need
to know to properly use the system -- thus enabling stark novices to
effortlessly achieve success, as well as those struggling at 2 AM, in a
distant hotel room, or on Sunday afternoon (i.e., when no one is available
The bad news is that seeing this type of guide will tell other programmers/
developers how to create and design comparable systems without spending
umpteen hours learning the nature of the business.
(The Scottish Terrier Lover)