Re: Technical Review Guidelines

Subject: Re: Technical Review Guidelines
From: "McMARTIN, Robert" <rmcmarti -at- BAEA -dot- COM -dot- AU>
Date: Fri, 11 Sep 1998 10:37:04 +0930

I would add, one thing,

* When making a correction of a word, or sentence, always draw a line
in the outside margin.

The writer may miss a small change in a line, but a line on the outside
of the page always gets attention.

regards


---------------------------------------------------------------

"Bother" said Pooh, as he strafed the lifeboats.

---------------------------------------------------------------
Robert McMartin
Documentation and Training Development Officer
British Aerospace Australia
677 Victoria Street,
Abbotsford, Victoria,
Australia 3067
61 3 9208 0532
---------------------------------------------------------------
Robert McMartin does not speak on behalf of British Aerospace
Australia and they agree.


> -----Original Message-----
> From: Kathryn Marshall [SMTP:kmarshall -at- MODACAD -dot- COM]
> Sent: Friday, 11 September 1998 10:52
> To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
> Subject: Re: Technical Review Guidelines
>
> 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.
>
> Kathy Marshall
> ModaCAD Inc.
> Culver City, CA
>
>

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




Previous by Author: Re: The Snowball Technique (Stone Soup)
Next by Author: Re: An Idea: An International Directory of Technical Terms
Previous by Thread: Re: Technical Review Guidelines
Next by Thread: Technical review guidelines


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

Sponsored Ads


Sponsored Ads