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.
On June 7th J. Fraser posted:
I've been asked to devise a version numbering scheme for our
documents (user manuals, design docs, specs, requirements, etc.). I'm
curious to know how you set up your version numbering.
Hi J. Fraser:
I am late on this, and you may have already gotten all of the help that you
need. Thought I'd just pass along my experience for what it's worth to you.
I also had to establish a document numbering scheme for tracking and
control. I looked at all of the types of documents that we'd be producing,
and found in our case three main types -- manuals, data sheets, and
application notes. I allocated part of the alpha-numbering scheme to reflect
the document type (ML, DS, AP). I then decided to follow that with a base
document number (in a simple sequential format -- the first manual I
produced became ML-001, to allow for growth up to 999). I then decided to
indicate version with a decimal number (ML-001.1 represents the first
revision to ML-001). This document control number is on every page of every
document that goes out to the user -- that way, if a help call comes in, the
user can be directed to look at the header of the page and read off the
document number, and the help desk will know if the caller is using current
documentation. I've added other types of documents to this scheme as
necessary -- brochures are BR-###, field service bulletins are FSB-###. For
my own internal use only, I also tack on a letter to the end of a version to
indicate the sort of revision that has taken place (A, B, or C levels -- A
being typos or small text or graphic changes, C being major changes
necessitating a redistribution to the field). This system has worked well
for me so far.
Catheryn Mason, Technical Writer
Infinitec Communications
cmason -at- infinitec-com -dot- com
(918) 481-5300 x280
fax: (918) 877-4007
Winner, 1999 IABC Bronze Quill Award of Excellence for Technical Writing
