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: Best practice for Edition or Revision History From:Lyn Worthen <Lyn -dot- Worthen -at- caselle -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 20 Jul 2004 09:51:41 -0600
Tammy -
Perhaps you can use as a model the method that is used when indicating
printing history in an ordinary book. In the front matter, where the
publisher's info, copyright, etc., are listed, you'll often see a little
line of seemingly random numbers (i.e., 45 46 47 48 49). I had no idea
what these numbers meant for a long time, until someone pointed out that it
indicated that this was the 49th printing of that book by that particular
publishing house.
Using that idea as a model, perhaps you can include in your revision history
chart a line for the document's origination (w/ the date, author, and other
pertinent info, etc.), followed by a line indicating a break in numbering
with a notation that earlier revision history may be found in an archived
copy (and a link/path for finding it), and then begin your revision history
list with, say, the last 3-5 revisions, in full, as you would normally
include them.
FWIW,
L
-----Original Message-----
From: tlloyd -at- xaware -dot- com
Sent: Monday, July 19, 2004 2:35 PM
Is there a standard limit for edition or revision histories?
...<snip>...
Some of our documents are now reaching more than ten versions, which is
taking up nearly a page in the Preface.
Is it necessary to list all of the document's versions? What is best
practice for including a document's editions (i.e., should we limit it to
the five latest versions or do we limit it to all document versions
released in the past calendar year)?
If we omit the oldest document versions, is it necessary to reference them
in some way so that users know there are even later versions of the
document?
ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl
WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
