RE: Version Revision number

Subject: RE: Version Revision number
From: "Pamela Sarantos" <Pamela -dot- Sarantos -at- bigbandnet -dot- com>
To: "Tara Charter" <tara -dot- charter -at- physiciansmutual -dot- com>
Date: Thu, 1 Dec 2005 14:54:21 -0500

Hi,

Our company uses the XXX.YYY format, as Paul references, for all
versions/releases of the documentation, to match the versions/releases
of the SW.

In addition, we use revision numbers to only the part number of the
documentation when there are changes in the documentation; for example:

O Initial publication of the document: Part no. xxx-xxxxxx.xx Rev
A0
O Change in documentation: Part no. xxx-xxxxxx.xx Rev A1, A2...

The above is the Rev number scheme for general availability documents.
Adding to this, if the publication is for field trials the revision
numbering scheme is Rev 10, 11...

We do not specify between significant or minor changes. How can we
define what is a significant or minor change? Something that may be
considered significant to one customer may be minor for another.

Thanks,
Pamela Sarantos
Sr. Technical Writer
BigBand Networks, Inc.

-----Original Message-----
From: techwr-l-bounces+pamela -dot- sarantos=bigbandnet -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+pamela -dot- sarantos=bigbandnet -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of Tara Charter
Sent: Thursday, December 01, 2005 2:15 PM
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.






____________________________________________________________
This message and any attachments are confidential, may contain
privileged information, and are intended solely for the recipient named
above. If you are not the intended recipient, or a person responsible
for delivery to the named recipient, you are notified that any review,
distribution, dissemination or copying is prohibited. If you have
received this message in error, you should notify the sender by return
email and delete the message from your computer system.

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

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
Pamela -dot- Sarantos -at- bigbandnet -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit
http://lists.techwr-l.com/mailman/options/techwr-l/pamela.sarantos%40big
bandnet.com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.

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

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-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Previous by Author: RE: Editing in Acrobat
Next by Author: RE: The second person in user guides
Previous by Thread: RE: Version Revision number
Next by Thread: RE: Version Revision number


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

Sponsored Ads


Sponsored Ads