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.
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
richardDOTcombs AT polycomDOTcom
rgcombs AT gmailDOTcom
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-