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: Reviewer's sign-off sheet From:Karen Kay <karen -at- WORDWRITE -dot- COM> Date:Fri, 21 Aug 1998 10:13:43 -0700
Jennifer O Neill said:
> I'm doing a sign-off sheet for the reviewers of our manuals and
> wonder what info or statements you include on yours. How specific do
> you make them to a particular manual or do you keep them general?
I'm in a new job at a new company with a brand new product (for me)
and our documentation is in the process of transitioning from printed
documentation to online help. So I'm very specific on the review sheet
about what it is they are reviewing and why they are reviewing it. One
of the most important things is that they review for what *isn't*
there. I spell that out on the review sheet and I've tried to go
around and talk to each reviewer about this issue.
The help is particularly thorny because we're giving them a printout
of a Frame file, and there are head 1s, 2s, and 3s. Eventually these
will all be mapped to h1, but for now they *look* hierarchical. It's
difficult for the reviewers not to take them as such. But each screen
will have to be able to stand alone, and we need our reviewers to tell
us if there is enough information on each screen.