Ep. 32 - How to Write Documentation

Open Hardware Manufacturing Podcast

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:

• Bill Hader - "when they tell you what's wrong they're usually right, when they tell you how to fix it they're usually wrong"
• Googles Style Guide
• Thea Flowers beautiful example of great documentation

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

Do you have any questions, comments, or topic suggestions? Email us at [e-mail]. 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:

• Complicate Ya - Otis McDonald (Creative Commons Attribution License)

---

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