Search a title or topic

Over 20 million podcasts, powered by 

Player FM logo
Artwork

Content provided by Stephen Hawes. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Stephen Hawes 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://staging.podcastplayer.com/legal.
Player FM - Podcast App
Go offline with the Player FM app!

Ep. 32 - How to Write Documentation

1:15:37
 
Share
 

Manage episode 449103253 series 3492769
Content provided by Stephen Hawes. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Stephen Hawes 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://staging.podcastplayer.com/legal.

Writing documentation is like a Greek tragedy, where you are both the best and worst person to write your own docs. In this episode, Stephen and Lucian dive deep into the art of creating effective documentation for open hardware products.


Join us as we explore the balance between text and images, the downsides of video documentation, and the ever-evolving nature of keeping your docs up-to-date. Whether you're a seasoned doc writer or just getting started, you'll find valuable insights and practical tips to enhance your documentation process.


Mentioned in this episode:

----------------------------------

Do you have any questions, comments, or topic suggestions? Email us at [email protected]. We'd love to hear from you!


To find out more about what we do, check out Opulo.io

To see everything else we do, including social media, check out Opulo.start.page


O.H.M. Podcast Merch is now here!


Intro song:


Hosted on Acast. See acast.com/privacy for more information.

  continue reading

39 episodes

Artwork
iconShare
 
Manage episode 449103253 series 3492769
Content provided by Stephen Hawes. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Stephen Hawes 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://staging.podcastplayer.com/legal.

Writing documentation is like a Greek tragedy, where you are both the best and worst person to write your own docs. In this episode, Stephen and Lucian dive deep into the art of creating effective documentation for open hardware products.


Join us as we explore the balance between text and images, the downsides of video documentation, and the ever-evolving nature of keeping your docs up-to-date. Whether you're a seasoned doc writer or just getting started, you'll find valuable insights and practical tips to enhance your documentation process.


Mentioned in this episode:

----------------------------------

Do you have any questions, comments, or topic suggestions? Email us at [email protected]. We'd love to hear from you!


To find out more about what we do, check out Opulo.io

To see everything else we do, including social media, check out Opulo.start.page


O.H.M. Podcast Merch is now here!


Intro song:


Hosted on Acast. See acast.com/privacy for more information.

  continue reading

39 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.

 

Listen to this show while you explore
Play