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: How to edit constructively? From:"Susan W. Gallagher" <sgallagher -at- EXPERSOFT -dot- COM> Date:Wed, 6 Mar 1996 13:50:48 -0800
At 09:57 PM 2/28/96 GMT, Glenda Jeffrey wrote:
>Can anyone post some suggestions on how to edit a writer's work so
>that you help the writer to improve? That is, what is the best way
>to supply constructive criticism?
>Some background: I am an engineer turned tech writer; I am managing
>three writers who are all writing software documentation. All three
>writers are also technical people turned writers.
Rather than concentrating on "improving" the writing styles of the
writers and supplying constructive criticism, why don't you approach
the problem as developing consistency within the writing team and
developing a corporate style. While you'll be doing the same thing
(essentially), you won't have to point fingers at good or bad, only
different -- and you won't be "improving", only homogenizing. This
can help take a lot of the "ego" sting away from the change.
Some strategies you can use in the process include:
Developing templates for different types of information
(for example a conceptual chapter should have these
elements in this order)
Developing a style guide (words to use/not use, where
to put commas and where to leave them out, boilerplate
phrases, constructions to avoid, etc.)
Brainstorming content sessions to give each team member
a voice in the outline of a book or manual set
I think you'll find the process much easier to approach this way. You
look more the hero than the heavy. And you'll probably find less
defensive attitiude in your path.
Just a thought...
-Sue Gallagher
sgallagher -at- expersoft -dot- com