Re: Document Review Process

Subject: Re: Document Review Process
From: David Neeley <dbneeley -at- gmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 2 Mar 2005 19:20:38 -0600

When I worked (all too briefly) for Nortel before their "troubles", I
was assigned to a switch that was a regularly purchased item for the
Department of Defense. Thus, we had both funding for maintenance and
upgrades and we had to have a record of the changes made that affected
that product.

We, too, had problems getting folks to respond in a timely fashion to
electronic versions, so we had to produce paper copies for
distribution to the SMEs. We also used a specific set of directions
for them regarding what we were looking for--mostly to verify
technical accuracy.

When the initial and individual review period was over, all the
involved SMEs met to go over the affected sections with the tech
writers assigned to those sections. This was scheduled well in advance
and was *not* optional. Of course, we also served refreshments--so it
was not so onorous for the SME types.

At the conclusion of that review meeting, everyone present signed off
on the doc with the agreed changes indicated...whereupon we
incorporated the changes and distributed the changed docs--this time
via .pdf files that were signed off again by the SMEs. These were the
documents that went into the software release (our docs were all .pdf
for that product).

However, any process you use for any sort of regulated environment or
one in which there are ISO aspirations must have a clear process that
can be easily audited. Since this also fixes blame, once the various
participants realize they cannot avoid it they will generally go
along. There is something about signing off on something you know
could bite you later that helps to focus the mind quite wonderfully!



Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:

Doc-To-Help 7.5 Professional: New version with new features, improved performance and reliability, plus much more! Download your free trial today at

You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

RE: Document Review Process: From: Laura Kate Barrett
Re: Document Review Process: From: Sarah Stegall

Previous by Author: Re: Trouble with FrameMaker 7.1 trial version...
Next by Author: Re: Identifying the source to generate a PDF?
Previous by Thread: Re: Document Review Process
Next by Thread: RE: Document Review Process

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

Sponsored Ads