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: document review process From:Robert Plamondon <robert -at- PLAMONDON -dot- COM> Date:Thu, 1 Aug 1996 11:55:02 PDT
Huntley Eshenroder writes:
>I work for a small software company where I am the only writer/editor, but
>not the only document producer (and one of the few native English speakers).
>We need to implement a document review process for manuals, data sheets,
>etc. Short of hiring another person (permanent or freelance), does anyone
>have any suggestions or ideas for doing this?
No, no, no! You need to implement an EDITORIAL function. The EDITOR will
choose to use a review process. You need to set up the editor as the
ultimate authority over style, language, and structure, with the goal
of quality, corporate image, and shielding the company from lawsuits.
Dig up the CHICAGO MANUAL OF STYLE (from the University of Chicago Press)
and use its section about how wonderful and important editors are as
The main point of this is that the concept of standards and control must
be agreed upon for any real progress to be made. Either everyone publishes
whatever they like, and there are no standards, or there is someone who
understands and enforces the standards. There is no middle ground.
Ideally, you should personally be anointed as The Editorial One, and then
you can make recommendations as to what additional steps need to be taken.
Don't ask for a corner office right away, but you'll want to gain control
of the printing and contracting budgets as quickly as possible, or some
yo-yo will raid them without telling you, and you'll be up the creek.
Robert Plamondon, President/Managing Editor, High-Tech Technical Writing, Inc.
36475 Norton Creek Road * Blodgett * Oregon * 97326
robert -at- plamondon -dot- com * (541) 453-5841 * Fax: (541) 453-4139
TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-