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:Review Process From:Marsha Kamish <MKamish -at- STEWART -dot- COM> Date:Tue, 29 Dec 1998 16:45:05 -0600
I have searched the archives and found some interesting material but most of
it is over a year old so I'm hoping y'all will bear with me. Here goes:
I have been tasked with developing a review process for in-house software
documentation. Has anyone any experience with such a process? (Boy, what a
stilted paragraph!) Do you know of any web sites that might prove helpful?
Here's what I've brainstormed so far:
Review process meeting to inform all of process.
Discussion/definitions/whatever of what technical review is versus editorial
review and who does which.
Checklist attached to portion of doc to review.
Timeline of project with review portion highlighted.
Time estimate for each reviewer.
Sign-off sheet with circulation list (who gets the piece next).
Is one technical review enough if the function doesn't change (I know, I
How many editorial reviews are necessary?
How do y'all feel about Judith Tarutz' (Technical Editing: The Practical
Guide for Editors and Writers) types of edits? Should I attempt to have one
reviewer per type of edit (i.e., Proofreader, Production Editor, Copy
Editor, Literary Editor, Developmental Editor, Technical Editor, etc.)?
Then what about the levels of edit? (See her Chapter 6!)
I'm going to stop now before they come to get me with their funny white
jacket. Please help. Thank you.