Re: determining document version

Subject: Re: determining document version
From: "Lisa Bronson" <Lisa -dot- Bronson -at- ipaper -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 28 Mar 2001 09:52:03 -0600

Mike asked, "At which point do you determine that your document has moved
to a different version?"



The two companies I have worked for where this was an issue determined it
this way:

--If it is a change that is backwards compatible (such as a correction,
addition, or improvement to a procedure), we do a revision.

--If it is a change that is NOT backwards compatible (such as a new feature
that was not previously available, or a different vendor's part with
different operating instructions), we make a new document.

In both companies, we used a numbering system where each section of a
manual was assigned a document number. When a backwards-compatible change
is made, we add "r1" to the end of the document number. When a
non-backwards-compatible change is made, we assign a new document number.

I don't know if it matters, but both of these companies are capital
equipment manufacturers. I am unsure if the same type of system would
apply to software manuals, because I have not done that type of work
(yet!). :-)

Hope that helps!

Lisa Bronson
Associate Technical Writer
Evergreen Packaging Equipment
Cedar Rapids, Iowa
319-399-3239


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

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com

A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/

---
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
http://www.raycomm.com/techwhirl/ for more resources and info.


Previous by Author: RE: Step structure (was RE: a question about verb tense/is or was ?)
Next by Author: Re: SQL for writers?
Previous by Thread: determining document version
Next by Thread: Re: determining document version


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

Sponsored Ads


Sponsored Ads