Re: Revision control

Subject: Re: Revision control
From: Julie Stickler <jstickler -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 7 Dec 2011 11:28:55 -0500

It all depends on how often you're revving your docs.

If you're releasing your docs when you release your software, just
number the docs to match. At previous companies we've had "User Guide
for WidgetPro 5.2" clearly displayed on the cover and in the footers
of the doc, and the file name was always something like
WidgetPro_UG_5.2.pdf, so you didn't even need to open the file.
Most places I've worked have had a quarterly release cycle, so things
were pretty managable.

But that mostly works if your company follows a logical release
numbering system, and when patches are bug fixes that don't affect the
docs. I'll be curious to hear how people are handling this at
companies that are using Agile and have more frequent release cycles.
I know there are companies out there releaseing software as often as
every three weeks.

On Wed, Dec 7, 2011 at 10:52 AM, <M -dot- Vina-Baltsas -at- mindray -dot- com> wrote:
> we don't know which manual to send
> them because that history is not maintained anywhere in the manual.
> How do the rest of you manage this?

Julie Stickler
Blogging about Agile and technical writing

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.

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-leave -at- lists -dot- techwr-l -dot- com
or visit

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 for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at


Revision control: From: M . Vina-Baltsas

Previous by Author: Re: Help! Authoring/maintaining content directly in RoboHelp 9 (HTML) -- Best practices...?
Next by Author: Re: need suggestions on handling a boss
Previous by Thread: RE: Revision control
Next by Thread: Re: Revision control

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

Sponsored Ads