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: Reprinting a manual before new software version
Subject:Re: Reprinting a manual before new software version From:Beth Agnew <BAgnew -at- INSYSTEMS -dot- COM> Date:Fri, 2 Jul 1999 08:48:35 -0400
We have manual EDITIONS that go out with software VERSIONS. That's how we
keep it straight if we've updated the manual but the software hasn't
changed. So a customer might have version 2.1 of the software and a "Product
Name version 2.1" (Second Edition) manual. However, if the manual was
updated because of new or changed functionality in the product, the software
should be released as a different version, too. If all you're doing is
making manual changes (fixing errors, adding information that was missed,
etc.) then go the second edition route. You can always send a letter to
existing customers to let them know that a second edition of the manual has
been published, do they want it? Or simply send every customer the second
edition.
--Beth
=============================================
Beth Agnew
Manager, Information Development
InSystems Technologies Inc. Phone: (905) 513-1400 x 280
65 Allstate Parkway, Suite 100 Fax: (905) 513-1419
Markham, Ontario, Canada E-mail: bagnew -at- insystems -dot- com
L3R 9X1 http://www.insystems.com
-----Original Message-----
From: Darren Barefoot [mailto:dbarefoot -at- MPS-CANADA -dot- COM]
Sent: Wednesday, June 30, 1999 5:19 PM
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Subject: Reprinting a manual before new software version
<snip> ... we are running out of manuals and are planning a reprint.
However, the manual has been
significantly updated to reflect functionality changes and generally become
better. However, it's unlikely my company name it version x.1. <snip>