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.
Subject:Re: Format for receiving document reviews From:John David Hickey <jdavid -at- FARABI -dot- COM> Date:Fri, 19 Jun 1998 15:53:02 -0400
Greetings!
>* Do any of you use the method of printing out documents and
>asking the reviewer to write their comments directly on the paper?
This is my preferred method. Althought some developers have horrible
handwriting, most of the time I can decipher their comments and add my own
comments for my own notes. Also, it makes it easier to go see the developer
in person if you have the original document on paper. On a more tedious
note, if the developer ever says "I never said that!", you've got your
proof that he did on paper. <eg>
>* How have you dealt with the "unresponsive" reviewer?
Go see them personally and ask specific questions. If the reviewer is still
unresponsive, get them to sign-off on your copy to say that he read it, he
loves it, and he thinks you are a genius. This will either get the reviewer
to confirm that all the data in the manual is perfect, or he'll have to
admit that he didn't really read it.
>* How do you ensure that you do receive comments back from the
>reviewer in a timely manner?
Include a cover sheet that clearly states when you expect to get comments
back. A couple of days before the deadline, drop by/call/tackle the
developer and kindly remind them that you'll be expecting review comments
back by your deadline.
>* Do you have any examples good and bad experiences with reviews
>of your documentation? Please share!
One time, I handed off a manual to be reviewed to the head of the
development team. Unbeknownst to me, he didn't have time to read it, so he
handed it off to his marketing person, who handed it off to the head
programmer, who handed it to the rookie programmer, who handed it off to
the testers, who handed it back to the head of the development head with an
A-OK on it. Of course, no one read it.
Another time, I handed off a manual to be reviewed to the head programmer
and I gave him a week to look at it. When we met the following week, he
shoved the manual back at me and said "It's crap." Shocked, I asked him
what was wrong with it. He shrugged and said "Well... I didn't really have
time to read it, so I gave it to my mother and she didn't like it." Honest
to Goddess!
Be seeing you,
Dave
---
John David Hickey -- Technical Writer -- jdavid -at- farabi -dot- com
No trees weres harmed in writing this email.
My messages are made from elephant tusks and dolphin meat.
Don't confuse my opinions with my employer's opinions.
Each exists in blissful ignorance of the other.
---
