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?”

Brush Up Your Punctuation and Grammar Skills

With more and more of us stuck at home because of the 2020 COVID-19 pandemic, or out of work because of it, this might be the perfect time to brush up on some basic (and sometimes forgotten) rules of punctuation and grammar.

Leah Guren, an experienced TechComm trainer and presenter, has started a new online series of quick tips for technical writers, editors, and content developers.

Follow Leah’s informative (and always entertaining) mini-presentations on her LinkedIn page.

From Around the Web: Do Editors Make Mistakes?

Are technical editing practitioners infallible? We might like to think we are, but we also make mistakes.

UC San Diego Extension copyediting instructors Lourdes Vernard and Christine Steele have complied a list of what they consider to be the top ten most common mistakes made by copy editors.

Do you have anything to add to this list? Write it below in the comments!

Conversation Starter: In Response to the Claim That Technical Editors Need Not Be “Grammarians”

(Editor’s Note: Michelle Corbin’s article, “Technical Editors Do Not Need To Be Grammarians,” started a very interesting conversation about technical editing and grammar.
The following lengthy comment was posted to the original article; to make it easier to continue this fascinating discussion, I’ve turned it into a standalone post.
Please feel free to continue discussing this – send your comments to editor@stc-techedit.org.

By Odile Sullivan-Tarazi

Perhaps it comes down to what you mean by “grammar.”

Continue reading “Conversation Starter: In Response to the Claim That Technical Editors Need Not Be “Grammarians””

The Best of Corrigo: Technical Editors Do Not Need To Be Grammarians

By Michelle Corbin
(originally published in 2013, republished with permission in 2019)

After reading a grammar textbook, I have been pondering how well technical editors need to know grammar. How much grammar must they know to edit the information, but also how much must they know to help their writers improve their writing ability?

Continue reading “The Best of Corrigo: Technical Editors Do Not Need To Be Grammarians”