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.
> 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?
We keep ours as general as possible (speeds up the process). Just make sure
you cover all the bases. The content really depends on your goals, but this is
what appears on our review cover sheet:
Document Name
Review draft (first, second, final, other)
Part number
Version number
Writer's name (let the SMEs know whom to return the review to)
Date circulated
Completion date
Explain the review process to the reviewers (is the review collated, serial,
high impact review (see Technical Writing Tips Summary by Douglas Max))?
Let reviewers know if the document has been spell checked (the last thing you
need is some engineer telling you how to write)
Provide space for additional notes (either from you or the SMEs).
Provide the names of each reviewer with space for their initials or sig.
(perhaps a table):
Department Reviewer Initials No Comment See Comments
----------------------------------------------------------------------------------------------
Service Jane Doe
Marketing John Smith
Tech Pubs
Hope all this helps.
Keith Wolfe
Associate Technical Writer at Large
Merge Technologies Inc.
