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.
Does the document itself have a number? Sometimes companies have P/N
(product numbers) that go on a manual for a product, or communications
departments have their own numbering scheme for their communications
products. I'm guessing that's not the case here; otherwise, there would
probably be a convention for revision numbers, such as P/N 22222/1,
where /1 is the revision number.
An alternative is to use an edition number, version number, or revision
number on the document. Your second iteration of the doc could be
Edition 2 or Revision 1. You can track the edition/revision numbers and
dates on the copyright page.
jan.
Jan E. Patterson
Senior Technical Writer
Environmental Systems Products
Tucson, Arizona
-----Original Message-----
From: techwr-l-bounces+jan -dot- patterson=esph -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+jan -dot- patterson=esph -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of obair81 -at- comcast -dot- net
Sent: Wednesday, May 03, 2006 9:40 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: doc release numbering
Due to things beyond my control, we (I) had to turn out a doc set last
week for a new hardware product, and next I will have to turn out
another (updated) doc set for the same product. The product name/number
have not changed.
Is there any sort of standard for numbering versions of the docs, if the
product is not changing?
I have not dealt with this question before.
The voice(s) of experience would be welcome.
Thanks.
best,
Paul
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l