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.
Hi Sara,
Our process is roughly the following:
* First review - peer and SME edit
* Second review - my manager edits
* Third review - the VP edits.
I don't find this ideal, but it's a whole lot better than nothing. For instance, I'd love to have a professional editor with authority doing substantive editing somewhere in the process. What happens instead is that everyone involved makes style edits, when they're not necessarily qualified to do so.
In your case, I'd try to get reviews for content from your SMEs, and try to keep reviews of style from SMEs to a minimum.
That you need a review of some kind before release just seems so obvious I'm at a loss to provide arguments.
HTH,
Eileen Neumann
Business Rules and Procedures
Toronto
-----Original Message-----
From: Sara Hassen [mailto:Sara -dot- Hassen -at- stratagene -dot- com]
Sent: Wednesday, March 02, 2005 11:49 AM
To: TECHWR-L
Subject: Document Review Process
Good Morning,
I am trying to develop a document review process for my division. I am
the lone Technical Writer within a group of scientists (Ph.D. level).
It is the common assumption that every document I produce should be 100%
error free. This of course is a daunting task. I strive to maintain
accuracy, but without a review process, the errors are unnoticed until
the document is utilized. I proof all my documents twice prior to
release, but this is obviously not adequate. This brings me to the
conclusion that a formal review process needs to be implemented.
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.
Thank you very much for your time to help me out!
Sara Hassen
Technical Writer
Notice: All email and instant messages (including attachments) sent to
or from Franklin Templeton Investments (FTI) personnel may be retained,
monitored and/or reviewed by FTI and its agents, or authorized
law enforcement personnel, without further notice or consent.
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
Doc-To-Help 7.5 Professional: New version with new features, improved performance and reliability, plus much more! Download your free trial today at www.componentone.com/techwrlfeb.
---
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 http://www.techwr-l.com/techwhirl/ for more resources and info.
