Last week, after learning the basics of how to write a document for translation, I started to think about the next step. We have two editors on our virtual team, both of whom are working in the industry and sound like they know what they are doing, but what actually is the role of an editor in technical communications and what makes a good one?
Rude and Eaton (2010) believe that the editor is a specialist role and they are experts in communication, language and the needs of the audience. They also state that a good editor can evaluate the big picture as well as the finer details. These experts are just what we need on our team as we had five writers from different continents working on the same document. Our finished product needs to have one voice, correct grammar and be useful to our target audience.
The Audience
The editor needs to consider the documents purpose and how the readers are going to use it. The document needs to be structured so that readers can find information quickly. Does the document need a hierarchy to make it easier on the reader to find simple information first? The document also needs to function correctly. Are the steps in the right order? I know when the editors were reviewing our written instructions the functional edit took longer than expected.
Safety notices must always be included and the editor should also be graphically aware, not experts but have an understanding of how the design elements will work with the rest of the document.
Working with the writers
In our project, the editors were involved from the start and collaborated on key decisions to be made regarding the written instructions. They also gave advice and feedback during the writing process which was very beneficial and they drafted style tips for us to follow. They then set up a private channel on Slack for each writer to receive edit feedback on their first draft. This process has worked well even though there were delays with some of the writers. It’s important to be tactful when giving feedback to a writer. I like the praise sandwich. This ensures that plenty of positive feedback is given surrounding the negative information. New writers will make lots of mistakes at the start, the editor needs to recognise this and give them praise where its deserved.
Getting feedback from the editors
I’m sure it’s frustrating for writers who have spent lots of time working on a document to get it back from the editor with loads of notes. Take the time to go through the notes carefully. The notes are not personal, the editor has a duty to make the end product as good as it can be. If you’re unsure about some of the comments, ask for clarification. Work through the changes. You will end up with a better document and you may learn something along the way.
References:
Rude, C. and Eaton, A. (2010) Technical Editing, 5th Ed, Longman
Contemplating Writing 