Re: Change Control for Documentation

Subject: Re: Change Control for Documentation
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "Beth Agnew" <Beth -dot- Agnew -at- senecac -dot- on -dot- ca>, "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 30 Nov 2007 08:41:19 -0500

Most of the best companies I've worked with use the
same change order system that applies to any other
part. Proposed changes are documented in an ECO
(Engineering Change Order) that describes the change,
why it is needed and what the priority is. The ECO
is evaluated, and if the proposed change does not drive
an immediate revision it is put into the release system
as "defer to next revision" change. Any attempt to
release a new revision that does not reference the
ECO will result in a flag in the release system that
has to be resolved, either by making the change or
deferring it again. The companies I've worked with
that treated documentation differently from "real
product" have all turned out to be bad experiences.

Gene Kim-Eng

----- Original Message -----
From: "Beth Agnew" <Beth -dot- Agnew -at- senecac -dot- on -dot- ca>
> 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?


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.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

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 for more resources and info.

Documentation Delivery - print or CD?: From: bphuettner
Re: Documentation Delivery - print or CD?: From: Sandy Harris
Change Control for Documentation: From: Beth Agnew

Previous by Author: Re: How do you differentiate yourself (UserFriendly)
Next by Author: Re: How do you differentiate yourself (UserFriendly)
Previous by Thread: Change Control for Documentation
Next by Thread: technical communications in Norwegian

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

Sponsored Ads