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?

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.

Of Interest: Presentations at STC Summit 2021

STC’s Technical Communication Summit is the premier conference for technical communication education and networking. The Summit attracts many attendees and exhibitors over a three-day period (7-9 June 2021), and brings together like-minded individuals to grow in their knowledge of the technical communication field.

As in past years, members of the Technical Editing SIG will be presenting talks at the Summit. To help you easily find them, we’ve put together a list. Please attend and encourage our members! (To register for the Summit, click here.)

Continue reading “Of Interest: Presentations at STC Summit 2021”

Of Interest: Definition of Quality (Editing) Panel at ConVEx 2021

Every documentation team strives to produce high-quality content. Unfortunately, the definition of what that means differs significantly, from company to company, from writer to writer, from user to user.

On 28 April 2021 at 0630 EDT at ConVEx 2021, a panel of top-class editors (Dana Aubin, Andrea Studzinski, and me too! :)) will talk about how to identify and prioritize the critical factors that influence the perception of quality, and discuss the best ways to achieve agreement on its definition.

To be a part of this fascinating discussion, as well as get more career-empowering knowledge, practices, networking, and practical solutions to improve your content strategy and technical documentation, register here: https://convex.infomanagementcenter.com

Of Interest: Feedback Finesse – The Art of Giving and Receiving Feedback

Technical communicators serve as a cornerstone in the flow of feedback through organizations that goes well beyond editorial feedback on different content types.

On 10 February 2021, at 3 PM EST (UTC-5), Liz Herman will show you how to add some finesse to the way you give and receive feedback in your organization. Learn new ways to deliver meaningful feedback. Understand how to thoughtfully respond to feedback. Leave with some artful ways to approach the flow of feedback and some specific resources for additional learning.

This is a joint STC Technical Editing SIGSTC Santa Barbara, and STC Los Angeles event, and is open to members and non-members:

  • TE SIG members: $0
  • P&P SIG members: $0
  • Santa Barbara chapter members: $0
  • Los Angeles chapter members: $0
  • Students: $0
  • Other STC members: $10
  • Non-members: $20

To register, click here.