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: Version Revision number From:"Joe Malin" <jmalin -at- tuvox -dot- com> To:"Tara Charter" <tara -dot- charter -at- physiciansmutual -dot- com> Date:Thu, 1 Dec 2005 12:42:29 -0800
In my previous job, we issued part numbers for books, and issued a new
part number each time the book was released for a new version of the
software. It was a bit of a judgment call, but we usually chose a new
part number if the change was significant. We did a rev number to the
existing part if we were updating the documentation independently of the
software.
In my current job, I update the version number to match its software.
So, if the software version is 2.0.2, my documentation is 2.0.2. If the
SW goes to 2.0.3 so do I, even if I didn't change anything.
I always use the same number of digits as the software does. We're at
two digits here, but in my previous job we were at four digits.
The decision involves interactions between manufacturing (who have to
figure out which part goes into which product), QA (who have to track
versions in the bug database, build team (who have to track versions in
source control, etc.), and marketing (who have several issues regarding
"new version" versus "new release" versus "minor upgrade").
Joe Malin
Technical Writer
(408)625-1623
jmalin -at- tuvox -dot- com
www.tuvox.com
The views expressed in this document are those of the sender, and do not
necessarily reflect those of TuVox, Inc.
-----Original Message-----
From: techwr-l-bounces+jmalin=tuvox -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+jmalin=tuvox -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Tara Charter
Sent: Thursday, December 01, 2005 11:15 AM
Cc: TECHWR-L
Subject: Version Revision number
My company is updating its Documentation Plan. The plan includes
guidelines for adding and updating the Version/Revision number to the
document (software development documentation).
The plan currently states that the version number shall be incremented
by one for significant changes and incremented by 1/10 for minor
changes.
The problem is lack of definition of "significant" and "minor". I'm
afraid we will all go back to the old ways (just add a version number
and make up your own rules) without some type of easy-to-follow
guideline.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
