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.
Thomas, thanks for sharing your technical review sheet. I particularly
like the checklist - great idea! You might consider condensing the
paragraphs of instructions because the SME probably won't read it. I
have distributed cover sheets with big, bold, all caps letters
requesting reviewers to use a colored pen -- only to receive a draft
marked up with a pencil. :-|
Our review cover sheet just has a bullet list of "review guidelines."
For example:
Review Guidelines
* Please review this document for technical accuracy only.
* Provide corrected/missing information if you know it, or suggest
a source.
* If you encounter information that you are not sure is accurate,
please ask someone who knows, or test it yourself. Never just leave a
question mark in the margin - if you as the technical reviewer don't
know, no one else will!
* Use a colored pen to mark your comments directly on the
document. For additional comments, attach a separate sheet and reference
the comments by page number.
I would change the line that says, "Please complete a technical
review..." to just "Review By."
Just to drill it into their heads, you might want to give the review
guidelines verbally to the SMEs. It maybe good to sit down with all the
SMEs (call a meeting maybe) and explain the importance of technical
reviews.
Looks good though - I would like to see your final draft.
