Technical Document Evaluation

Subject: Technical Document Evaluation
From: "CB Casper" <knowone -at- surfy -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 02 Apr 2003 13:01:54 -0800


We are changing our writing organization to emphasize
the 'technical' aspects of our jobs. We are expecting
our writers to become SMEs, and one aspect of this
to farm out the editing, formatting, and font fondling
to another group, so we can focus on the technology
and presenting it to our sys admin customers.

We are contemplating including an Evaluation form with
our documents when we send them to the lab for a
technical review, similar to an instructor evaluation
form filled out after a training class.

Has anyone done anything like this?

What can be asked of a technical lab person concerning
technical documentation in order to elicit useful
information? The intent is to obtain feedback on both
the technical content of the documentation and the
technical skills of the writer. With this evaluation
we hope to show the writers their weaknesses so they
can get the training they need to become better SMEs.

CB - part SME writer and part manager of SME writers
--
Surfy! http://www.surfy.net Great web search, free web email, and $9.95 unlimited Internet access

Powered by Outblaze

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Purchase RoboHelp X3 in April and receive a $100 mail-in
rebate, plus FREE RoboScreenCapture and WebHelp Merge Module.
Order here: http://www.ehelp.com/techwr-l

Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....

---
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.



Follow-Ups:

Previous by Author: Making a critical notice stand out
Next by Author: Re: ISO9001 recognition
Previous by Thread: Process defining Development (or "the dog wagging the tail")
Next by Thread: Re: Technical Document Evaluation


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

Sponsored Ads


Sponsored Ads