RE: How to version a document?

Subject: RE: How to version a document?
From: "Steve Cavanaugh" <scavanaugh -at- nat-seattle -dot- com>
To: "Cardimon, Craig" <ccardimon -at- M-S-G -dot- com>, "Geoff Hart" <ghart -at- videotron -dot- ca>, "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 29 May 2007 07:48:12 -0700

You should really have a look at ASME Y14.100 and the appropriate
related publications from the American Society of Mechanical Engineers.
They have devised a system that works and documented it well. Unless
you are willing to pay for it, you'll probably have to peek at it at the
local library.


Steve Cavanaugh
Sr. Technical Writer
NAT Seattle Inc.

-----Original Message-----
From: techwr-l-bounces+scavanaugh=nat-seattle -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+scavanaugh=nat-seattle -dot- com -at- lists -dot- techwr-l -dot- com]
On Behalf Of Cardimon, Craig
Sent: Friday, May 25, 2007 5:36 AM
To: Geoff Hart; TECHWR-L
Subject: RE: How to version a document?

Let's go for simple and robust, so I can remember it and follow it
myself without too much trouble.

All I want to achieve is letting the user know they are looking at a new
version of the documentation.

-----Original Message-----
From: Geoff Hart [mailto:ghart -at- videotron -dot- ca]
Sent: Thursday, May 24, 2007 4:52 PM
To: TECHWR-L; Cardimon, Craig
Subject: How to version a document?

Craig Cardimon wondered: <<How does one "version" a document? >>

Depends on what you mean by your question and what your goals are.
Versioning can be:
- simple and robust, but with no access control: just add the revision
date to the end of a file name to create a new version
- software-specific (e.g., using the Versions feature under Word's file
menu)
- complicated, sophisticated, and proportionally expensive: using
dedicated version-control software that provides access control,
revision tracking, etc..

So: what are you trying to achieve by versioning? That lets us discuss
the appropriate tool for the job.


----------------------------------------------------
-- Geoff Hart
ghart -at- videotron -dot- ca / geoffhart -at- mac -dot- com
www.geoff-hart.com
--------------------------------------------------
Coming soon: _Effective onscreen editing_ (http://www.geoff-hart.com/
home/onscreen-book.htm)



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

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 &amp; 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 &amp; Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as scavanaugh -at- nat-seattle -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/scavanaugh%40nat-seat
tle.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.


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

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 &amp; 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 &amp; 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.


Previous by Author: RE: A Survey: Do You Name Your Images in a Std Way?
Next by Author: Re: Finding errors in manuals
Previous by Thread: Re: How to version a document?
Next by Thread: RE: How to version a document? (take II)


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


Sponsored Ads