RE: Revision control

Subject: RE: Revision control
From: Jonathan Pechta <jonathan -dot- pechta -at- Q1Labs -dot- com>
To: "M -dot- Vina-Baltsas -at- mindray -dot- com" <M -dot- Vina-Baltsas -at- mindray -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 7 Dec 2011 16:25:51 +0000


For our releases we use subversion to manage all of our files. The source content for a documentation release is assigned to a branch with all of the software. Once a release occurs, the branch is locked or archived and we start working in a new subversion branch.

The document control number ties back to the subversion source documents as the document control number is unique and contains a date and revision level. This number appears on the cover and in the footer information. If there is ever an issue, we can check out the previous source files matching the document control number and verify our content.

For our online help, I have our help server script in an html comment
after the compile is complete.
<-- Product X, Build Y. Built from SVN Commit 123456 -->

It is an easy way for our customer support or QA people to know what version of the help and SVN commit they are testing on or supporting. They can press Cntl+U and get the online help version in the title of the source.




-----Original Message-----
From: techwr-l-bounces+jonathan -dot- pechta=q1labs -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+jonathan -dot- pechta=q1labs -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of M -dot- Vina-Baltsas -at- mindray -dot- com
Sent: Wednesday, December 07, 2011 11:52 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Revision control

I write Ops manuals for a medical device manufacturer. We use revision
control for our manuals but we do not indicate anywhere in the manual
which version of the software the manual relates to. So, when a client
calls our Service department or one of our clinical educators and says
that they need an additional manual, 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?

________________________________________________________________

Michelle Viña-Baltsas
Senior Technical Writer



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

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 jonathan -dot- pechta -at- q1labs -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/jonathan.pechta%40q1labs.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.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

To unsubscribe send a blank email to
techwr-l-leave -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.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com


References:
Revision control: From: M . Vina-Baltsas

Previous by Author: Re: What doc formats do readers actually use? Was, "what doc formats do READERs want ?"
Next by Author: Re: Help! Authoring/maintaining content directly in RoboHelp 9 (HTML) -- Best practices...?
Previous by Thread: RE: Revision control
Next by Thread: Re: Revision control


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


Sponsored Ads