RE: How to version a document

[Beth Agnew <Beth -dot- Agnew -at- senecac -dot- on -dot- ca>]

Users need two important pieces of information when determining whether the
manual they are looking at is current: 1) the date of publication of the
manual, and 2) the version of the product that they need information about.

The manual should always be in sync with the product version. If you are
providing a manual about Luna v3.1 then the cover of the manual should
distinctly show that it is for v3.1, whether there was a version 2 manual or
not. 

However, you sometimes have to release a subsequent version of the manual.
In that case, I make it a second edition, and change the date on the cover
and in footers. I do NOT change the "version" number of the manual. It's
still for v3.1.

Obviously, if the manual is being released (even without any text changes at
all) for Luna v4.0 it now becomes the v4.0 manual. You can say First Edition
on the copyright page but it's not necessary. Always include the date of
"publication" of the manual.

You can have any kind of internal versioning system you want that makes
sense to you and your colleagues, as long as the users have a clear
indication of those two items mentioned.
--Beth

Beth Agnew
Professor, Technical Communication
Seneca College of Applied Arts and Technology
416-491-5050 x3133

-----Original Message-----
From: techwr-l-bounces+beth -dot- agnew=senecac -dot- on -dot- ca -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+beth -dot- agnew=senecac -dot- on -dot- ca -at- lists -dot- techwr-l -dot- com] On
Behalf Of Cardimon, Craig
Sent: Thursday, May 24, 2007 4:41 PM
To: Techwr-l
Subject: How to version a document

How does one "version" a document? 


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

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -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%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

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