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: Purpose of document review process? From:Kathleen Padova <kpadova -at- ASICENTRAL -dot- COM> Date:Mon, 12 May 1997 16:15:00 -0500
Colleagues--
In your experience, is the purpose of the document review process
1. smoking out details that were overlooked or misstated by the
writer -- getting feedback?
Definitely so. Very often, I would find changes in the program by surprise
(don't get me started on THAT). I would send a draft to development and ask if I
left anything out. Of course, I loved it when I got back a document full of
spelling and punctuation corrections but no word about content.
This would be the main purpose of sending out drafts.
2. handing out draft documentation to let folks know about the
product?
Also true. I'd give drafts to our customer service folks so they knew what was
coming down the line. Also being the people who had to deal with confused users
they'd point out areas that could use some further enhancement.
3. getting final signoff from all parties? (including an element
of "CYA")
I keep all signed off drafts for a year specifically for CYA. Sometimes if a
project seems outta control I make an issue of getting sign offs.
Obviously, it includes some of each of these, but can we explore
the relative proportion and basic purpose of reviewing?
--g
Guy K. Haas Software Exegete ghaas -at- netscape -dot- com
M/S MV-050 415-937-3773
Netscape Communications Corporation
501 Middlefield
Mountain View, CA 94043
My opinions are mine--Netscape's are their own.
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
