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.
Re: Suggestions for user manual with alternate versions
Subject:Re: Suggestions for user manual with alternate versions From:"Wesley T. Reisz" <wtreisz -at- RAQUE -dot- COM> Date:Thu, 26 Aug 1999 15:05:26 -0400
>>I searched the archives, but found few topics related to my question.
>>Is there a graceful way to document different versions of software in
>>the same user manual?<snip>
Terry,
I write custom manuals for automated production lines and processing
machinery. Although each of the machines are technically similar equipment,
the machines, the touchscreens used to control the machines, and their
actual makeup is continually in flux.
My first attempt to control the documentation was a large catch all. I tried
to put any and all information on specific machines in single volumous
manuals. It didn't work! The readers (who, first of all, tended to be lower
on the literacy totem pole) had problems understanding why there were
different instructions for the same machine, would confuse procedures, and
finally tended to find the manual contradictory. Perhaps that was my fault,
who knows. Long story short... If you can maintain a separate manual, do it.
Yes... it's time consuming and difficult to maintain (I use a database to
help me), but I've had more success at communication with targeted manuals.
Each circumstance is different, but for what it's worth that's my two cents
worth. Best of luck!
Regards,
Wes
