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:Change Control for Documentation From:Beth Agnew <Beth -dot- Agnew -at- senecac -dot- on -dot- ca> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 30 Nov 2007 07:44:36 -0500
What change control methods do you use for documentation in your
organization? In draft stages, I incorporate feedback, corrections and
changes into subsequent drafts, but as we get closer to deadline, I
typically go to a "bug priority" method that parallels those used in
software development. Anything considered a "showstopper", in that it
would cause the user trouble if left unchanged in (or left out of) the
final manual gets immediate attention and may even affect release date.
Other changes that are important but not particularly urgent may get
into the current manual or be prioritized for the next edition,
depending on how close we are to release. Nice-to-haves are incorporated
into the next version of the documentation.
I'm sure there are variations on the above. What have you found to work
in your shop?
--Beth
Beth Agnew
Professor, Technical Communication
Seneca College, Toronto
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-