Re: Reviewer's sign-off sheet

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.

Karen
karen -at- wordwrite -dot- com


From ??? -at- ??? Sun Jan 00 00:00:00 0000=



Previous by Author: Recently Opened Files (Frame)
Next by Author: JOB: tech writer, Ottawa area
Previous by Thread: Re: Reviewer's sign-off sheet
Next by Thread: Re: Reviewer's sign-off sheet


What this post helpful? Share it with friends and colleagues:


Sponsored Ads