Of Interest: What Does Documentation Quality Really Mean and How Do We Improve It?

By Yoel Strimling

As technical editing practitioners, we put a lot of time and effort into ensuring that the documentation we send our readers is of the highest possible quality. We want to make sure that it helps our readers do the tasks they need to do or understand the concepts they need to know.

But what do we mean when we talk about “documentation quality”? What do our readers mean when they talk about it? And is it the same thing we mean?

For the past seven years, I’ve been researching these questions. As a practicing technical editor, I don’t always have time available to investigate what readers want. But because I see myself first and foremost as a “reader advocate”, I feel that it is critical that we as technical editing practitioners have solid and empirical evidence to help us do our jobs better.

On 1 September 2021 at 0830 PDT (click here for your local time zone), join Liz Fraley, Janice Summers, and me in Room 42 for a lively and interesting discussion about how readers see documentation quality and how we can use this information to make them happy. And, after all, who doesn’t want happy readers?

A Little Humor: What Exactly Do Technical Editors *Do* Anyway?

Just another day in the life of a technical editor… 😀

So I’m reviewing this really long and complicated architecture specification document (written by a team of engineers), and I come across the names they’ve decided to call the modules: ELVIS and COSTELLO.
ELVIS stands for “ELementwise Vectorized Iterative Sequencer” and COSTELLO stands for “COmplementary STreaming ELementwise LOgic”.

It’s pretty clear that they were really proud of these backronyms, but something about them raised a red flag in my mind when I saw them.
Oh, wait – that’s right! You shouldn’t use names of famous people when naming your product! They might sue you! 😀

I remembered a famous case where Carl Sagan sued Apple for using his name internally for one of their products (https://lnkd.in/dtyqUnS).

So I contacted Legal and the engineers and told them “Listen, I like British New Wave just as much as the next guy, but you can’t call the modules this.”
They were disappointed.
But that’s one of the things that a technical editor has to look for – editing is more than just style and grammar!

Do you have a similar story you’d like to share?
Send it to editor@stc-techedit.org and maybe we’ll publish it here! 🙂

STC Summit 2021 Session Roundup and Recommendations

UPDATED 18 AUGUST 2021: Access to Summit OnDemand has been extended to 30 September 2021.

By Marcia Shannon

Even though the live virtual Summit is now history, STC is still offering Summit OnDemand with access to recordings of all of the Featured Speaker sessions, education sessions, and exhibitors on the virtual Summit platform. Access to all of these goodies will be available through 31 August 2021.

I believe this would be a good education investment for anyone interested in improving their technical communication skills. To help you decide whether to spend the money to access all of the recordings, here are some of my recommendations, based on my favorite sessions. I hope you find these recommendations useful whether you are catching up on sessions you could not attend in June or attending the virtual Summit for the first time.

Continue reading “STC Summit 2021 Session Roundup and Recommendations”

Of Interest: The Phases of Successful Freelance Technical Editing

Freelance technical editing can prove a rewarding career choice once you understand the subtle distinctions of the various flavors of the profession. Most substantial editorial workflows fall into seven phases, from acquisition editing to proofreading. Most freelance editors are stronger at some phases than at others.

On 7 July 2021 at 11 AM PDT (click here for your local time zone), STC Fellow Avon Murphy will present a session that will help you learn how to discover which phases best suit your temperament and skill set, and find more satisfaction in your freelancing career.

He will give some tricks of the trade that can help you make an impact in each type of editing. The result will be clients who understand what you’re doing at any point in the development of their projects, not to mention more focused and helpful editing.

To register for this event, click here.

Meet the Technical Editing SIG at the STC Summit 2021!

UPDATED: THE OPEN HOUSE IS FROM 12:45 TO 1:30 PM EDT.

Want to find out more about the STC Technical Editing SIG?

Want to meet and network with other technical editing practitioners?

Want to hear about the cool things we’re up to in the SIG – and maybe participate in them as well?

Come to the STC Technical Editing SIG Virtual Open House on 9 June 2021 from 1 – 1:45 PM EDT (click here for your local time)! The Zoom link is:
https://zoom.us/j/95239076337?pwd=Wi9RTWdwbkEyYllHUllJWTVQaENiQT09