TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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...
Meg
At 12:31 PM 4/25/01 -0400, Megan Golding wrote:
What strategies do you employ in getting real review and feedback on
your
documents?
[snip]
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 http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See http://www.infomap.com 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
http://www.raycomm.com/techwhirl/ for more resources and info.
