How to version a document? (take II)

Subject: How to version a document? (take II)
From: Geoff Hart <ghart -at- videotron -dot- ca>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>, Craig Cardimon <ccardimon -at- M-S-G -dot- com>
Date: Fri, 25 May 2007 09:08:05 -0400

Craig Cardimon provided more details: <<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.>>

Given that you're designing the version for the user of the manual,
not for in-house writers and reviewers, it's easy: start with a name
such as "FrustratoMax 2.1.1 user manual". That makes the match
between the manual and software versions clear, and you may not need
to go beyond that.

If you need to subversion <ahem> for some reason, simply add the date
of the release below the title: "May 2007 release". Add more details
as necessary (e.g., 25 May 2007, 9:07:32 AM EST, release) <g>.


----------------------------------------------------
-- 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 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.


Follow-Ups:

References:
RE: How to version a document?: From: Cardimon, Craig

Previous by Author: How to version a document?
Next by Author: Technical writing for finance: one for the Friday files
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