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.
Re: Naming conventions for superseded version numbers
Subject:Re: Naming conventions for superseded version numbers From:"Gene Kim-Eng" <techwr -at- genek -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 8 Oct 2003 09:19:11 -0700
If by "standards," you mean rules that are consistent within entire industries,
I'd say no, except for DoD contract work governed by MIL-STDs. In most
of the companies I've worked for/with, the *version* number (V1.0, V1.1,
V2.0, etc.) is keyed to the version number of the product being supported,
i.e., doc V1.1 corresponds to product release V1.1, and document-only
changes are identified by *revision* numbers or letters, i.e., Rev A, B, C,
or Rev 1, 2, 3 (the Revs being unique to the documents and not related to
product versions). In cases where there's a new product release that doesn't
involve any doc changes, we roll the V numbers with the product even
if there are no other changes required by the product release, and use it
as an opportunity to fix any errors that had been noted in the previous doc
release but hadn't justified a change.
Gene Kim-Eng
----- Original Message -----
From: "Nadine Underwood" <nadine -dot- underwood -at- orchard-systems -dot- co -dot- uk
>
> Are there any "standards" which I need to adhere to for numbering superseded
> manuals/Help files; e.g. when do you go from version 1.0 to 1.1, or 1.5 or
> even 2.0?
If by "standards," you mean rules that are consistent within entire industries,
I'd say no, except for DoD contract work governed by MIL-STDs. In most
of the companies I've worked for/with, the *version* number (V1.0, V1.1,
V2.0, etc.) is keyed to the version number of the product being supported,
i.e., doc V1.1 corresponds to product release V1.1, and document-only
changes are identified by *revision* numbers or letters, i.e., Rev A, B, C,
or Rev 1, 2, 3 (the Revs being unique to the documents and not related to
product versions). In cases where there's a new product release that doesn't
involve any doc changes, we roll the V numbers with the product even
if there are no other changes required by the product release, and use it
as an opportunity to fix any errors that had been noted in the previous doc
release but hadn't justified a change.
Gene Kim-Eng
----- Original Message -----
From: "Nadine Underwood" <nadine -dot- underwood -at- orchard-systems -dot- co -dot- uk
>
> Are there any "standards" which I need to adhere to for numbering superseded
> manuals/Help files; e.g. when do you go from version 1.0 to 1.1, or 1.5 or
> even 2.0?
RoboHelp for FrameMaker is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to online Help, intranet, and Web.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! Call 800-718-4407 for
competitive pricing or view a live demo at: http://www.ehelp.com/techwr-l3
---
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.
