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: How do you figure version numbers? From:"Hodge, Lisa" <LHodge -at- NaviSite -dot- com> To:"'techwr-l -at- lists -dot- raycomm -dot- com'" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 21 Apr 2000 08:27:36 -0400
The method used at my previous company worked very well because it allowed
readers to easily identify if a document was officially released or still in
development. It was a combo of numbers and letters that worked like this:
When a writer started drafting a new document, it was Rev. A. As changes
were made and new drafts were released for review, the document went through
revs B, C, D, etc. Once it was officially approved (everyone had signed off
in blood), it became Rev. 1 and was published.
If/when changes became necessary, Rev. 1 was updated to be Rev. 1a. As it
was going around for review and other edits were made, the document went
through Rev. 1a, Rev. 1b, Rev. 1c, etc. (Note that during this time,
everyone continued to use Rev. 1 to work from, as it was the only
"officially" approved document.) When Rev. 1x would be signed off, it became
Rev. 2.
On the documents themselves, the revision was always printed in the footer
as an extension of the document number...so some samples might be
800-4123-01-RA, 800-4123-01-R03, 800-4123-01-R02c, etc.
As part of our preparedness for ISO9001 certification (yes, we passed!), the
entire company was trained on the doc control numbering system, and knew
that they should never use a revision of a document that ended in an alpha
character to build, test, inspect, or service the product (unless the
product was in an alpha or beta testing phase). One other good idea...when
a document was in development, we ALWAYS used a "Draft" watermark in the
background of the page, since docs-in-development were often known to
"magically appear" in the customers' hands...and the customer didn't know
about the numbering scheme.
Hope this helps!
Lisa Hodge
Mgr, Tech Pubs
NaviSite, Inc.
lhodge -at- navisite -dot- com
-----Original Message-----
From: scott -at- soffront -dot- com [mailto:scott -at- soffront -dot- com]
Sent: Thursday, April 20, 2000 1:30 PM
To: TECHWR-L
Subject: How do you figure version numbers?
Hi,
I'm trying to create a numbering scheme for document revisions. Currently I
start at 1 and working my way up (2, 3, 4, etc.). I have had a suggestion
to make my revision number match the software version I am writing for,
however, I have had two revisions for one software version release (so that
doesn't work).
Any suggestions on how you or your company figures revision numbers?
Thanks!
Scott
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sponsored by Weisner Associates Inc., Online Information Services
Training & consulting for RoboHELP, Dreamweaver, HTML, and HTML-Based Help.
More info at http://www.weisner.com/train/ or mailto:training -at- weisner -dot- com -dot-
Sponsored by 4Translation.com, Language Translation Simplified.
Instant on line quotations and free samples available for technical
documentation. http://www.4translation.com Any File...Any
Language...Anytime
---
You are currently subscribed to techwr-l as: lhodge -at- navisite -dot- com
To unsubscribe send a blank email to leave-techwr-l-31671B -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.
