Listen "Ep. 32 - How to Write Documentation"
Episode Synopsis
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 [email protected]. We'd love to hear from you!To find out more about what we do, check out Opulo.ioTo see everything else we do, including social media, check out Opulo.start.pageO.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.
More episodes of the podcast Open Hardware Manufacturing Podcast
Ep. 46 - Deciding What to Work on Next
14/11/2025
Ep. 45 - Advertising
02/10/2025
Ep. 44 - Are Degrees Worthwhile?
12/09/2025
Ep. 43 - Collaboration in Open Source
28/08/2025
Ep. 42 - Certifications
18/07/2025
Ep. 41 - Surviving the Bus Test
19/06/2025
Ep. 40 - Influential Media
05/06/2025
Ep. 39 - Starting a Hardware Company
15/05/2025
Ep. 38 - Taking Prototypes to Production
27/02/2025
Ep. 37 - Keeping Sales Up
07/02/2025
ZARZA We are Zarza, the prestigious firm behind major projects in information technology.