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.
Subject:RE: How to version a document? (take II) From:"Cardimon, Craig" <ccardimon -at- M-S-G -dot- com> To:"Geoff Hart" <ghart -at- videotron -dot- ca> Date:Fri, 25 May 2007 09:25:14 -0400
Well put.
I love "subversion." I can't wait to subvert myself.
I don't mean to sound too sarcastic -- I'm a "wordie."
Craig
-----Original Message-----
From: Geoff Hart [mailto:ghart -at- videotron -dot- ca]
Sent: Friday, May 25, 2007 9:08 AM
To: TECHWR-L; Cardimon, Craig
Subject: How to version a document? (take II)
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 & 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-