Category: Best Practices

Posted on

Of Interest: Soft Skills for Technical Editors

Traditionally, editors have had to fight the stereotype of being crotchety. After all, old newspaper movies always showed the copy editor as someone who could not get along with anyone else and had been banished to a dark corner of the office forever correcting others’ articles and never getting a chance to write any of his or her own. The reality is, though, that editors provide feedback on other people’s work product, and they will be so much more successful if they do so with kindness and empathy.

On 7 May 2024 at 1200 PM ET (click here for your local time), join Fatima Hyder to find out what soft skills editors need to be successful and make editing collaborative and not confrontational!

For tickets, go to https://www.eventbrite.com/e/soft-skills-for-technical-editors-tickets-695325175317.

Posted on

Of Interest: You’re Wrong. My Documentation Is Brilliant!

On 30 January 2024 at 1200 PM ET (click here for your local time), join Jeff Klein for an interesting discussion about the complexities technical writers encounter when navigating negative feedback that is generic, vague, and utterly lacking in specificity. Uncover an effective approach to identify the underlying issues that feedback providers often struggle to articulate. Learn a practical methodology you can implement that will transform their non-actionable critique into a roadmap for enhancing the precision, clarity, and impact of your technical documentation.

For tickets, go to https://www.eventbrite.com/e/youre-wrong-my-documentation-is-brilliant-tickets-788846088887.

Posted on

The Fundamentals of Technical Communication: Throw Out Your Thesaurus and Pick Up a Style Guide

by Chelsea Fulton

Consumers of technical content are hardly a captive audience. Typically, our readers need help setting up a product and troubleshooting errors. Rarely, if ever, do technical content consumers browse our websites and white papers for entertainment. Our consumers are purpose-driven. Therefore, technical content creators must be accurate, explicit, concise, and consistent.

  • According to Demand Metric, consistently presented brands are 3 to 4 times more likely to experience brand visibility.
  • A study by Marq determined that consistently presenting a brand can increase a company’s average revenue by 10-20%.
  • BBC News found that one spelling mistake can cut online sales in half.​ 

The bottom line is that consistency and quality matter.

Consistency is one of the fundamental differences between technical writing and other writing styles. Effective technical communication is uniform. The margin of interpretation for technical content should be next to non-existent. So, how does a team of 15 technical writers tasked with creating and maintaining hundreds of documents write in a way that is indistinguishable to an untrained eye?

An internal style guide, that’s how.

Continue reading “The Fundamentals of Technical Communication: Throw Out Your Thesaurus and Pick Up a Style Guide”
Posted on

Coming Soon: The STC TESIG Editors’ Exchange 2023 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 happy to announce EdEx23, an online mini-conference dedicated to the field of technical editing and to technical editing practitioners.

EdEx23 will be held on 14 November 2023 from 8:45 AM to 12:00 PM ET (for your local time, go to https://tinyurl.com/cw228pyx). Come hear the following fascinating speakers:

  • Chelsea Fulton will be presenting a session called “Write It Right: Implementing a Global Style Guide“.
  • Fatima Hyder will be speaking about “Technical Editors – What Are They Good For?“.
  • Leah Guren will talk about “Don’t Touch That Doc ’til You’ve Had the Talk!”.

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

To see details about the presentations and to purchase tickets for EdEx23, go to https://tinyurl.com/35w7ae8p.

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 recordings and slides will be made available to attendees after the mini-conference.

EdEx23 attendees who are STC members can earn up to 2 CEUs for the full half-day program. For credit, submit a request for CEUs to certification@stc.org.

Posted on

Editing in a Structured Environment

by Kit Brown-Hoekstra

As new technologies expand omni-channel publishing requirements and companies extend the global reach of their products, services, and content marketing, the role of editor becomes both more critical and more strategic. Effective editorial, governance, and change management processes directly impact a company’s bottom line.

Continue reading “Editing in a Structured Environment”