We found lots to talk about when a newer writer asked about editing etiquette. She’d written a blog post and was surprised to see it published with changes she’d never seen and didn’t necessarily agree with.
Should the editor send a revised version back to the author for review, or is it normal to see one’s name attached to text that doesn’t reflect your own writing style or even your own ideas? Is the situation different for bylined posts and journal articles, as opposed to, say, instruction manuals and web pages that don’t name the author? How much revision is normal? Can you, should you, or would you want to, use such a revised piece in your portfolio if the words are not entirely your own?
In this case, the new writer was providing content for an organization that hadn’t worked with technical writers before. Someone suggested that this provides a great opportunity to diplomatically educate the editor: ideally, the editor and writer work as a team to make the piece as useful as possible to the reader. It’s not the editor’s job to rewrite the author’s work arbitrarily, but the writer should expect some revisions on the way to the best possible version of the work. The editor discusses the revisions with the writer to be sure the edits haven’t changed the meaning or “voice” of the writer inappropriately. The writer respects and welcomes the feedback; an experienced editor can be a valuable teacher and coach. Building this collaborative relationship benefits everyone: writer, editor, and audience.
We also agreed that it’s best to discuss the writing and editing process before starting, to avoid surprises. If you want final approval or review of the text, ask for it. One writer reminded the group that as technical writers we have to “remove ourselves from the writing.” Our work belongs to the employer or client who paid for it and we don’t usually own it. Sometimes, especially when a byline is involved, the author might own the copyright and control the use of the text, but that’s uncommon.
We also discussed self-editing. It’s easy to hand a “good enough” draft to an editor to fix, but if you clean it up yourself first, you’ll learn more and find it more satisfying — and your editor will appreciate it. Tools such as readability scales, grammar checkers, and the Hemingway app can help.
The Tech Comm Café provides networking opportunities, job leads, answers to work-related dilemmas, and a burst of professional energy to keep you motivated. We discuss technical writing tools and techniques, career planning, portfolios, and anything else related to working as a technical communicator.
We welcome anyone who’s interested in technical communication — contractor, in-house, student, long-time tech writer, STC member, non-member, career-changer, or recruiter. We hope to see you at the next meeting!
Next Meeting: ONLINE on Wednesday, June 15, 2022
- Subscribe to receive email announcements of future meetings.
- If you plan to attend, RSVP by 4 p.m. Wednesday, June 15, to receive login instructions.
Date: Wednesday, June 15
Time: 7:00-8:00 p.m. Pacific Time
Location: Online via Zoom
Agenda
- Introductions. Take 60 seconds to introduce yourself, your background, current activities. A good chance to try out that new elevator speech.
- Announcements and job leads. If you know of an interesting event or a job opening, or you’re looking for work, share it with the group.
- Brainstorming Q&A. Ask about a work-related problem and discuss potential solutions.
- Speed networking. Make new contacts and discuss your professional backgrounds and goals.
Heather Sommerville is a senior technical writer and editor with over 20 years of experience delivering clear, concise writing for business and technical audiences. She is an STC Associate Fellow and has served in many volunteer positions with the STC Canada West Coast chapter.