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.
Chuck Beck asked for guidance on revision dates: when and how to use
them when the document changes rapidly.
Hmmm.... interesting problem! And I don't know of an obvious easy
answer. However, you didn't tell us how this is being distributed,
whether it's a shippable product or an in-house program, if you distribute
change pages only or a whole new manual, or how critical it is that the
end user know that the version they have is the most recent. For ISO
9001 purposes, this can be essential, but for many other purposes it may
not be sufficiently important to justify the hassle of constant updates.
One possibility is to put it online. Then whatever they access is current.
This works if it's an internal document.
Limit published updates to quarterly, then include all revisions
accumulated to that point.
One way of deciding if it's a new revision is whether or not there has
been substantive change. If so, it's a new revision, otherwise it's just an
update or intermediate version, like the "V6.2" for software.
Good luck - it's not a trivial problem.
mikim -at- mcdata -dot- com
TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-