Best practice for Edition or Revision History

Subject: Best practice for Edition or Revision History
From: tlloyd -at- xaware -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 19 Jul 2004 14:35:13 -0600


Hello,

Is there a standard limit for edition or revision histories?

In each preface, we include an Edition History in which a comprehensive
list of the document's editions are listed. For each edition, the edition
(e.g., First) and its part number, the product version the document
accompanies, and the major changes that were made to the document are
included in a table format.

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?

I've searched the web and referenced a few technical writing guides, but I
can't find any set rules or suggestions for this.

Any help that is offered will be greatly appreciated.

Thank you,

Tammy Lloyd

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.



Previous by Author: RE: opposite of 'assert' -- 'de-assert' OR 'deassert'?
Next by Author: The number of listings in an edition history
Previous by Thread: Re: Zero value
Next by Thread: RE: Best practice for Edition or Revision History


What this post helpful? Share it with friends and colleagues:


Sponsored Ads