Re: Documentation Review Strategies?

Subject: Re: Documentation Review Strategies?
From: Megan Golding <mgolding -at- secureworks -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 01 May 2001 14:25:01 -0400

Thanks to everyone who provided tips and comments on getting solid review from people! My review cycle is going well -- I'm getting good feedback from nearly everyone to whom I submit the document. One thing I think is really helping is that reviewers are looking at one chapter at a time. Most reviewers will not review more than one to two chapters in the manual. This helps substantially reduce burnout.

Tips I especially liked:
1. Be specific to reviewers about what they're reviewing for so you get the kind of review you want.
2. Julie Brodeur had a great idea: "...I recommend setting up a
team meeting--highlight your questions and get them answered all at
once..." In fact, her idea of highlighting questions was seconded by several people. This helps direct the reviewer's attention.
3. Steven Shepherd described a doc plan and signoffs. I have actually been using a part of his suggestion (and didn't realize how it was helping). My documentation schedule is written into our overall software development plan. The documentation is a deliverable, just like the code, to QA for testing. When the developers have "doc review" with their initials next to it on the project plan, they are immediately responsible.

Again, thanks to everyone! Now -- back to finishing this project...


At 12:31 PM 4/25/01 -0400, Megan Golding wrote:

What strategies do you employ in getting real review and feedback on

Megan Golding | mgolding -at- secureworks -dot- net
Technical Writer | SecureWorks, Inc.

"Tell me and I'll forget. Show me, and I may not remember. Involve me, and I'll understand." - Native American Proverb


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

Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See or 800-463-6627 for more about our solutions.

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: Thanks: canvas drawing in html
Next by Author: Re: File naming conventions in Acrobat
Previous by Thread: RE: Information Mapping Template
Next by Thread: A question of structure

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

Sponsored Ads