RE: Best Practice for reviewing documents

Subject: RE: Best Practice for reviewing documents
From: Beth Agnew <Beth -dot- Agnew -at- senecac -dot- on -dot- ca>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 20 Dec 2005 08:48:12 -0800

Five business days for a review is usually adequate. Any longer, and they
just don't get to it; shorter and they feel under pressure so you may not
get your best review. I would have all in-house people review it at the same
time. Each person is going to be looking for different things -- you for
grammar/editorial, someone else for technical accuracy, etc. Even the peers
will each have different things they pick out of the document. You may even
want a formal review process: http://tinyurl.com/djlpf

I'd keep the number of reviews to a minimum. You don't really want to be
seeing the document over and over again. Gather up all the comments, rather
than have different individuals making their changes in the document. You
want to know what all the change recommendations are, so that the consensus
can be incorporated into the document.

Perhaps leave the final review to just you and the operations team lead.
Once he signs off on your edited copy, it's done.

I always stress document ownership. Who is the person who is most invested
in that document being correct? That individual checks the client feedback,
and if it warrants a further edit, then it can be done.

Having a good change control policy will help you here. What consistutes a
change, in your view? At any point in the review process, someone might want
to add or remove something. Under what circumstances do you allow that, and
when do you "freeze" the document from further changes? It may help to think
of document edits in the same terms as software bugs. Some are important,
others not as critical.
--Beth

Beth Agnew
Professor, Technical Communication
Seneca College of Applied Arts & Technology
Toronto, ON 416-491-5050 x3133
http://www.tinyurl.com/83u5u

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

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Follow-Ups:

References:
Best Practice for reviewing documents: From: Lucero, Peggy

Previous by Author: Re: New Poll Question / Introduction
Next by Author: Re: Fwd: Two Contracts?
Previous by Thread: Re: Best Practice for reviewing documents
Next by Thread: RE: Best Practice for reviewing documents


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

Sponsored Ads


Sponsored Ads