Artwork

Content provided by TC Camp. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by TC Camp or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.
Player FM - Podcast App
Go offline with the Player FM app!

What is Documentation Quality?

51:12
 
Share
 

Archived series ("Inactive feed" status)

When? This feed was archived on February 27, 2024 01:29 (7M ago). Last successful fetch was on July 09, 2022 08:08 (2y ago)

Why? Inactive feed status. Our servers were unable to retrieve a valid podcast feed for a sustained period.

What now? You might be able to find a more up-to-date version using the search function. This series will no longer be checked for updates. If you believe this to be in error, please check if the publisher's feed link below is valid and contact support to request the feed be restored or if you have any other concerns about this.

Manage episode 333775051 series 3369444
Content provided by TC Camp. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by TC Camp or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.

In this episode, we discuss how readers define documentation quality is being used by technical communication departments around the world to collect meaningful and actionable feedback, and provide reliable methods and metrics for measuring documentation quality.

Yoel Strimling has been spinning straw into gold for over 20 years, and currently works as the Senior Technical Editor/Documentation Quality SME for CEVA Inc. in Herzelia Pituach, Israel. Over the course of his career, he has successfully improved the content, writing style, and look and feel of his employers’ most important and most used customer-facing documentation by researching and applying the principles of documentation quality and survey design. Yoel is an STC Associate Fellow, a member of tekom Israel, and the editor of Corrigo, the official publication of the STC Technical Editing SIG.

For the past seven years, Yoel has been researching these questions. As a practicing technical editor, he doesn’t always have time available to investigate what readers want. But as a “reader advocate”, he feels that it is critical that technical communicators have solid and empirical evidence to help them do their jobs better.

As technical communicators, we put a lot of time and effort into creating the highest-quality documentation we can. We write because we want to help 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 transcript, links, and show notes: https://tccamp.org/episodes/what-does-documentation-quality-really-mean-and-how-do-we-improve-it/

  continue reading

49 episodes

Artwork
iconShare
 

Archived series ("Inactive feed" status)

When? This feed was archived on February 27, 2024 01:29 (7M ago). Last successful fetch was on July 09, 2022 08:08 (2y ago)

Why? Inactive feed status. Our servers were unable to retrieve a valid podcast feed for a sustained period.

What now? You might be able to find a more up-to-date version using the search function. This series will no longer be checked for updates. If you believe this to be in error, please check if the publisher's feed link below is valid and contact support to request the feed be restored or if you have any other concerns about this.

Manage episode 333775051 series 3369444
Content provided by TC Camp. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by TC Camp or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.

In this episode, we discuss how readers define documentation quality is being used by technical communication departments around the world to collect meaningful and actionable feedback, and provide reliable methods and metrics for measuring documentation quality.

Yoel Strimling has been spinning straw into gold for over 20 years, and currently works as the Senior Technical Editor/Documentation Quality SME for CEVA Inc. in Herzelia Pituach, Israel. Over the course of his career, he has successfully improved the content, writing style, and look and feel of his employers’ most important and most used customer-facing documentation by researching and applying the principles of documentation quality and survey design. Yoel is an STC Associate Fellow, a member of tekom Israel, and the editor of Corrigo, the official publication of the STC Technical Editing SIG.

For the past seven years, Yoel has been researching these questions. As a practicing technical editor, he doesn’t always have time available to investigate what readers want. But as a “reader advocate”, he feels that it is critical that technical communicators have solid and empirical evidence to help them do their jobs better.

As technical communicators, we put a lot of time and effort into creating the highest-quality documentation we can. We write because we want to help 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 transcript, links, and show notes: https://tccamp.org/episodes/what-does-documentation-quality-really-mean-and-how-do-we-improve-it/

  continue reading

49 episodes

All episodes

×
 
Loading …

Welcome to Player FM!

Player FM is scanning the web for high-quality podcasts for you to enjoy right now. It's the best podcast app and works on Android, iPhone, and the web. Signup to sync subscriptions across devices.

 

Quick Reference Guide