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: Tech Review Template From:Janice Gelb <janice -dot- gelb -at- eng -dot- sun -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 24 Jan 2001 13:42:08 -0800
Here is a text version of the sample tech review letter
we provide in _Read Me First: A Style Guide for the
Computer Industry_:
TECHNICAL REVIEW COVER LETTER
To: Reviewer List
From: Writer Name
Subject: Technical Review of [Name of Book]
Date: Date
The attached manuscript is the technical review version
of [Name of Book]. Please review the entire manuscript,
paying special attention to the notes/questions to
reviewers. All open issues and unanswered questions
must be resolved for this technical review to be complete.
I would appreciate your general comments as well as
specific answers to the issues raised in the notes.
Please give detailed and thorough responses. Also,
please address the specific review responsibilities
of your department.
[NOTE: Our Style Guide detailed the specific review
responsiblities for each department]
[Add any comments regarding specific issues/content.]
Your review must be returned by [ p.m.] on [Date.] After
reviewing your responses, I will discuss any discrepancies
at the technical review sign-off meeting, which will be
held:
Date, at Time
Name Conference Room
Due to the tight production schedule, please make
wording or style suggestions only if they affect the
technical accuracy of the text.
Thank you very much for your attention to these documents.
Your comments are appreciated and contribute greatly to
improving the quality of [Company Name] documentation.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area. http://www.pdfconference.com or toll-free 877/278-2131.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
