DiscoverConvergenceHow to Write Effective Technical Documentation
How to Write Effective Technical Documentation

How to Write Effective Technical Documentation

Update: 2022-08-24
Share

Description

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
It is safe to say that the ways we learn how to use new platforms have evolved since Windows 95, mainly because of the new ways we use technologies. So how can you write better documentation that enables your users to understand how to use your platform properly?

In this episode, Yaakov Simon, Cato Networks’s Documentation Manager, will uncover the most common documentation strategies in an agile service-based company vs a static product-based company.
Comments 
loading
00:00
00:00
1.0x

0.5x

0.8x

1.0x

1.25x

1.5x

2.0x

3.0x

Sleep Timer

Off

End of Episode

5 Minutes

10 Minutes

15 Minutes

30 Minutes

45 Minutes

60 Minutes

120 Minutes

How to Write Effective Technical Documentation

How to Write Effective Technical Documentation

Cato Networks