Re: Revision identity issues

Subject: Re: Revision identity issues
From: "Alex Silbajoris" <alsilba -at- hotmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 01 May 2003 13:01:40 +0000


I suggest you include a revision history, with release dates, in each manual. Then if a manual is not printed in a certain language until a certain revision number, that will be shown because the first revision will be listed as 2.1.C, etc. Also, in the case of a revision number jump, the history will show the gap, so no one will say "we never got a version 2.1.D like the English manual" etc. The release dates would provide a second data point for reference, so someone could see that the Lithuanian 2.1.E and the English 2.1.E were released on the same date.

In my company, we need to adopt better version identification. We have been using a hard-coded revision date in our footers, but this is a leftover from when we published all our manuals as Word documents (online or hardcopy). We recently began to put a revision history in our manuals as an appendix. This history indicates which revisions to the systems are included in that version of the manual.

We produce software systems which are modified incrementally, without major version re-releases to the entire system. Usually these arise because of a particular project authorized to enhance or add some element of the larger system. So our manuals need to show whether a certain project is included in that version of the manual.

- A

STOP MORE SPAM with the new MSN 8 and get 2 months FREE*


Robohelp X3, from eHelp, lets you quickly and easily create professional Help systems for all your Windows and Web-based applications, including Net.
Order RoboHelp X3 in May and receive a $100 mail-in rebate, PLUS
free RoboScreenCapture and WebHelp Merge Module.
Order RoboHelp today:

You are currently subscribed to techwr-l as:
archive -at- raycomm -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 for more resources and info.

Previous by Author: Re: Bunch of similar texts
Next by Author: New Here (Take 3!)
Previous by Thread: Re: Revision identity issues
Next by Thread: Re[2]: what do you call your online manuals

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

Sponsored Ads