RE: Revision control

Subject: RE: Revision control
From: "Combs, Richard" <richard -dot- combs -at- Polycom -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 08:23:37 -0800

M -dot- Vina-Baltsas -at- mindray -dot- com wrote:

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

1) Identify the version to which the manual applies on the cover page.
2) Assign the manual a part number (also on the cover page) and add that to the BOM (bill of materials) for the product release.
3) Go through a formal release process for each version of the product and its manual(s).
4) Ensure that, like the released version of the software, the released version of the manual(s) is preserved or can be restored.

Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-903-6372
------








^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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: Identifying embedded screen shot names in Framemaker
Next by Author: RE: Revision control
Previous by Thread: Re: Revision control
Next by Thread: RE: Revision control


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

Sponsored Ads


Sponsored Ads