Artwork

Content provided by Mariela leibovich and Cato Networks. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Mariela leibovich and Cato Networks 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!

How to Write Effective Technical Documentation

26:19
 
Share
 

Manage episode 339368515 series 3378240
Content provided by Mariela leibovich and Cato Networks. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Mariela leibovich and Cato Networks 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.

When it comes to technical documentation, the first thing that comes to mind is probably a 600-page User Manual (like the kind that comes with a Windows 95 or an AOL installation). And, these user guides were created to tell us how to understand technical software inside and out.

It’s safe to say that the way we use new tech has evolved since Windows 95. So how do you write effective documentation that allows users to understand your software, product or tech service?

In this episode, Yaakov Simon, Cato Networks’ Documentation Manager, highlights the differences in documentation strategies for agile, service-based companies vs static, product-based companies

  continue reading

18 episodes

Artwork
iconShare
 
Manage episode 339368515 series 3378240
Content provided by Mariela leibovich and Cato Networks. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Mariela leibovich and Cato Networks 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.

When it comes to technical documentation, the first thing that comes to mind is probably a 600-page User Manual (like the kind that comes with a Windows 95 or an AOL installation). And, these user guides were created to tell us how to understand technical software inside and out.

It’s safe to say that the way we use new tech has evolved since Windows 95. So how do you write effective documentation that allows users to understand your software, product or tech service?

In this episode, Yaakov Simon, Cato Networks’ Documentation Manager, highlights the differences in documentation strategies for agile, service-based companies vs static, product-based companies

  continue reading

18 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