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: Revision control From:M -dot- Vina-Baltsas -at- mindray -dot- com To:Julie Stickler <jstickler -at- gmail -dot- com> Date:Wed, 7 Dec 2011 11:38:00 -0500
This cracked me up, "But that mostly works if your company follows a
logical release
numbering system..." We don't always have a logical release schedule. We
DO try but it doesn't work out that way. We ship when the software testing
is finished and our bugs are at a minium! ;-)
I can add the rev and SW version to our revision page but am not sure how
to handle the maintenance releases/patches, etc. For example, something
like "Version 2.3, 2.3.1, 2.3.2" might work, right?
Tel: 201-995-8350
m -dot- vina-baltsas -at- mindray -dot- com
STRICTLY PRIVATE & CONFIDENTIAL.This email may contain confidential and
proprietary material for the sole use of the intended recipient. Any
review or distribution by others is strictly prohibited. If you are not
the intended recipient please contact the sender and delete all copies.
From:
Julie Stickler <jstickler -at- gmail -dot- com>
To:
techwr-l -at- lists -dot- techwr-l -dot- com
Date:
12/07/2011 11:28 AM
Subject:
Re: Revision control
Sent by:
techwr-l-bounces+m -dot- vina-baltsas=mindray -dot- com -at- lists -dot- techwr-l -dot- com
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 http://heratech.wordpress.com/
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. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as M -dot- Vina-Baltsas -at- mindray -dot- com -dot-
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. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
