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: Dos and don'ts for R & D From:John Gilger <bjgilger -at- CLASSIC -dot- MSN -dot- COM> Date:Wed, 25 Feb 1998 00:50:28 UT
Good Morning,
When the group I was working with a couple of years ago faced this problem,
our solution was to include a temporary section in the draft document titled
"Review Comments."
This section had several copies of a form we made that was designed for
reviewers to enter their name, organization, i.e., SME, H&S, Design
Engineering, etc., and any comments they had.
We enforced a policy that the tech writers would only consider comments
documented on these forms. Anything else was just idle conservation.
Another advantage was that in some cases the reviewers would actually read one
another's comments and identify conflicting issues.
John Gilger
Independent Wordsmith
Bjgilger -at- msn -dot- com
6363 Red Comet Ct.
Las Vegas, NV 89115
702.459.1102
-----Original Message-----
From: Technical Writers List; for all Technical Communication issues On
Behalf Of Steve Williams
Sent: Monday, February 23, 1998 11:14 PM
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Subject: Dos and don'ts for R & D
I'd like to put together a list of "Dos and Don'ts" to be used by our R&D =20=
=20
people
when checking the factual content of technical documents. It seems that =20
they all have different ideas on what has to be checked and how suggested =20=
=20
changes should be indicated in the document.
Before embarking on such an enterprise I thought it best to check with =20
you people in case someone has some pointers. Perhaps someone has already =20=
=20
done something like this.