Newbies’ Corner: User or Rulebook, Guide or Grammarian?

Editor’s Note: This is the first article in the Newbies’ Corner series, which is intended to give a platform to new, fresh voices, especially from those who are studying the field or just starting out. If you are a student learning about technical editing or just starting out on your technical editing journey, and would like to submit an article, please send an email to editor@stc-techedit.org.

by Nathan Richardson

As technical communicators and editors, we know about the importance of user-centered processes. There’s a growing demand for user experience (UX) writers and UX designers, and for building UX into our organization’s (or personal) content strategy from the start.

We also have a foundational commitment to “the rules.” Our work builds on reviewing content and suggesting changes in media, style, grammar, voice, and tone, among other things. We question the accuracy and completeness of a given communication and its content. For example, when editing a set of instructions, we could follow the steps, seeking errors or missing information. As technical editors, we may also try to break those instructions and identify their limits—which provides our authors with insights they might have missed. We also look for consistency, ensuring that, for example, fractional measurements are plural and consistent (think 0.7 inch vs. 0.7 inches, and within the same document .8 inches becomes 0.8 inches). We ask: are all references to other publications, articles, or patent-related prior art accurate?

Continue reading “Newbies’ Corner: User or Rulebook, Guide or Grammarian?”

This Worked for Me: How Do You Want That Edited?

By Yoel Strimling

While technical editors might be great, most of us aren’t miracle workers. We have deadlines, resource issues, multiple tasks, and so on. While we want the documents we send to our readers to be as good as they can be, we realize that we can’t do everything, and that some sort of compromise needs to be made. The “golden triangle” of Good/Cheap/Fast calls on us to pick only two.

So what do we do? We have to let the document authors (be they technical communicators or engineers) know exactly what we can do and how long it will take us, and then help them plan accordingly. When everybody is “on the same page” and all expectations are clear, the editing process runs much smoother.

Continue reading “This Worked for Me: How Do You Want That Edited?”

New Feature: Newbies’ Corner!

As the official publication of the STC Technical Editing SIG, Corrigo is full of useful information for technical editing practitioners.

But a lot of it is written by old fogies who have been in the business for many years.

Wouldn’t it be great to hear some new, fresh voices, especially from those who are studying the field or just starting out?

To provide a platform for new ideas and thoughts about our chosen profession, we are introducing a new feature – Newbies’ Corner!

This new feature will present articles written by technical editing students and aspiring, newly minted technical editing practitioners.

To make it easier for you to find these articles again in the future, they will be tagged with a Newbies’ Corner tag, and the titles prefaced with the same phrase.

If you are a student learning about technical editing or just starting out on your technical editing journey, and would like to submit an article, please send an email to editor@stc-techedit.org and let’s discuss it.

License to Edit: Techniques for Technical Editing Success

By Ann Marie Queeney

The exciting exploits of James Bond may seem far removed from the field of technical editing. However, after reading a book titled, The Man with the Golden Typewriter: James Bond’s Letters I recognized that Ian Fleming––the creator of the iconic spy series––was a disciplined writer whose commitment to clear, sharp writing and accuracy shares many similarities with good technical editing practices.

This article draws upon the mentioned book’s witty and insightful letters between Fleming and his editing team at Jonathan Cape (his publisher), friends, and Bond fans to discuss good editing practices. 

Continue reading “License to Edit: Techniques for Technical Editing Success”