RE: Documentation Review Strategies?

Subject: RE: Documentation Review Strategies?
From: michelle -dot- black -at- sickkids -dot- ca
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 25 Apr 2001 13:28:39 -0400

Greetings, Megan.

I have adopted the practice of adding a Log Sheet to drafts, where I explain
changes, signal changes on specific sections, or enquire on issues I'm concerned
about. This is set up as a dialogue with the client, who I ask to look at and
respond to my questions/comments. I find that it helps overcome a lot of the
resistance to having an editor rewrite your stuff, since I often position my
explanations of changes in the context of research findings and my experience
with what might better help the users of the information.

I also like your idea of breaking up the document into content-specific chunks,
so the reviewer doesn't have such a daunting task on his or her hands. In this
spirit, I also try to ensure that my log sheets don't run more than 1-2 pages.
And, I take out the questions or comments that have been attended to before
doing the next draft--that allows me to add comments recommendations to it that
are more relevant at the later stages: suggestions for design and format,
potential field testing scenarios, and so on.

Michelle Black


*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at or info -at- devahelp -dot- com

Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East,
June 4-6, Baltimore, MD. Now covering Acrobat 5. Early registration deadline
April 27.

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

Previous by Author: RE: Making them read the documentation
Next by Author: RE: Making them read the documentation -- "alliterates"??
Previous by Thread: RE: Documentation Review Strategies?
Next by Thread: Documentation review strategies?

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

Sponsored Ads