This Worked For Me: Tackling Complex Content as a New Editor

by Jill Mazza

For some, the saying, “Those who can’t do, teach” may be true. For me, it speaks some truth about learners being my best teachers.

I am a trainer on effective technical writing. But my learners and I are not the same type of technical professionals. They are mostly engineers, scientists, and statisticians. While I can’t technically do their jobs, I do help them to see their written content through the eyes of non-technical readers.

At the training firm I work for (WD Communications), I design writing programs using our clients’ technical documents, such as investigation reports and procedures. When first in this niche role of editor-designer-trainer, I was overwhelmed. Literally. My background was in psychology, business communication, and coaching. It was hard enough to see my way through technical content at all, let alone edit anything.

How was I going to tackle such complex content?

Continue reading “This Worked For Me: Tackling Complex Content as a New Editor”

Coming Soon: The STC TESIG Editors’ Exchange 2022 Mini-Conference!

The goal of the STC Technical Editing SIG (TESIG) is to provide its members with high quality information about editing processes and best practices, as well as resources that demonstrate the value of editing and editors in an organization.

To meet this goal, we are launching the first of what we hope will be an annual event – an online mini-conference dedicated to the field of technical editing and to technical editing practitioners.

Continue reading “Coming Soon: The STC TESIG Editors’ Exchange 2022 Mini-Conference!”

Book Review: Proof Positive – How to Find Errors Before They Embarrass You

by Noel Atzmiller

Proof Positive – How to Find Errors Before They Embarrass You
By Karen L. Anderson
©1996 by SkillPath Publications. Mission, Kansas (193 pages)

I recently found a job that requires me to perform extensive proofreading/editing of technical documents. Before I started, I wanted to obtain some guidance and tips on how I could perform my tasks well.

I visited a local used bookstore, scanned their shelves, and found a book titled Proof Positive. After glancing at the Table of Contents and reading several random pages, I knew I found just what I needed. Although book was printed in 1996, inside this document was information crafted to encourage and equip a person to become an excellent proofreader.

Now, I know you might wonder if a book that focuses on proofreading is applicable for editors. I think it is. The proofreader helps to make sure the document author follows the rules determined by an editor. By detecting and correcting infractions within an accepted code of language content, the proofreader is working with an editor and enabling the author to produce the best possible document.

The author of this book, Karen Anderson, is a nationally recognized writer, trainer, and communications consultant. As the owner of her own consulting firm, she has taught business professionals techniques for producing polished, quality documents.

Her extensive knowledge is found within the first pages of the document, where she provides practical answers to crucial questions that a proofreader must know, such as:

  • “How can a proofreader prepare to proofread successfully?” p.9
  • “Where will a proofreader find the most errors in documents?” p.19
  • “How can a proofreader do a good job when there is too little time before the deadline?” p. 25

Anderson continues by offering several clever techniques to find errors in a document. She recommends reading text backward, starting with the last word in a paragraph and moving to the beginning, to help find spelling and usage errors. Holding a single-sided copy up to a light with the print facing away from view reveals mistakes with short words and poor formatting. Locating hyphenation and leading issues is possible by rotating a hard copy 90 degrees with the right margin pointing up.

Anderson also provides chapters that explain correct grammar and review punctuation guidelines, but she avoids a stodgy recitation of rules. She offers short exercises that give the reader an opportunity to practice the guidelines she proposes.

Poor verbal habits can also creep into documents. Errors can occur because the proofreader thought a sentence “sounded right” and “looked” correct. Anderson reacts to this by listing corrections to many common mistakes and guidance on avoiding poor word choice, redundant words, wordiness, jargon and cliches.

The copious advice in the document culminates in a chapter that details some tools a proofreader can use to track their documents for error-free publication. Tracking slips, error logs, and a personalized proofreader checklist are just a few of these practical tools.

Five appendixes include information on proofreader marks, commonly misspelled words, misused words, transitions, and type specifications.

The only downside of the book is that it focuses entirely on printed documents; it does not provide guidance for proofreading web-based text. However, many of the tips and guidelines can still be used for non-print documentation.

Throughout the document, Anderson conveys repeated encouragement to the proofreader. This feature and the numerous tips and guidelines make Proof Positive a valuable reference for beginning or experienced proofreaders.

This book is available on Amazon (amazon.com), AbeBooks (abebooks.com), and other online book sellers. Check it out!

Conversation Starter: What Are Your Thoughts About “Male” and “Female” Connecter Ends?

Editor’s Note: As part of our Conversation Starter feature, we present what we hope will be an ongoing discussion about the evolution of the English language, especially the use of gendered descriptive adjectives. For a related topic, see Conversation Starter: How Do You Feel About the Singular “They”?

Want to join the conversation? Email your thoughts to editor@stc-techedit.org, or write them in the Comments section at the end of this article. We’ll publish them in future issues.

Professor Jo Mackiewicz of Iowa State University is studying how editors make editorial decisions about issues related to gender, and has put together a short survey about the about the use of “male” and “female” to describe connector ends (for example, the end of a cable or a pipe fitting). The survey should take just 5 to 10 minutes, depending on the detail you provide in your responses

The findings of this study can help editors better understand how other editors make editorial decisions related to gendered descriptive adjectives.

To participate in this study, go to: https://iastate.qualtrics.com/jfe/form/SV_4TpOSYCPEARiJMy

If you have any questions, please contact Prof. Mackiewicz (jomack@iastate.edu).

Announcing the STC Technical Editing SIG Editors’ Exchange 2022 Mini-Conference!

The STC Technical Editing SIG is proud to announce its first official mini-conference – EdEx2022!

The goal of the STC Technical Editing SIG (TESIG) is to provide its members with high quality information about editing processes and best practices, as well as resources that demonstrate the value of editing and editors in an organization.

To meet this goal, we are launching the first of what we hope will be an annual event – a mini-conference dedicated to the field of technical editing and to technical editing practitioners.

EdEx2022 will be held on 15 November 2022 from 8:45 AM to 12:00 PM ET (for your local time, go to https://bit.ly/3ARVwEn).

We especially encourage students and new technical editing practitioners to join us!

To see details about the presentations and to purchase tickets for EdEx2022, go to https://www.eventbrite.com/e/stc-technical-editing-sig-editors-exchange-2022-mini-conference-tickets-372579063007.

The price of the tickets is for the entire mini-conference, and attendees can join at any time. All sessions will be recorded, and the recording and slides will be made available to attendees after the mini-conference.