Re: Document Review Process

Subject: Re: Document Review Process
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 2 Mar 2005 09:57:38 -0800

Our documents get three reviews:

1. Template review (by writers, engineering, marketing)
(conducted each time we change the standard
document structure, not for each document)
2. Writer peer review
3. Technical "pre-flight" review by engineer

Our company's approach is that the engineers developing
a product are 100% responsible for ensuring technical
accuracy of everything that goes into the product, and the
documents are part of the product. No document is released
without the engineer's written clearance that it is technically
correct. Usability, grammar, style and other "touchy-feely
tech pubs issues" are our responsibility, and complaints
from the field in those areas come to us, but if the data in
the document is technically inaccurate, the hammer falls
on the developers.

Gene Kim-Eng

----- Original Message -----
From: "Sara Hassen" <Sara -dot- Hassen -at- stratagene -dot- com>

My question to you is this, how many reviews do your documents undergo
prior to being released for use? Also, who are the people who review
the documents, end-users, fellow writers?

I appreciate any and all comments. I am at my wits end trying to
articulate the need for document review PRIOR to release. I am hopeful
the information I learn from all of you will assist me.


Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:

Doc-To-Help 7.5 Professional: New version with new features, improved performance and reliability, plus much more! Download your free trial today at

You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.


Document Review Process: From: Sara Hassen

Previous by Author: Re: Part of QA WAS: Software Development Documents
Next by Author: Re: Control Issues
Previous by Thread: Document review process?
Next by Thread: Re: Document Review Process

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

Sponsored Ads