Open Hardware Manufacturing Podcast

Ep. 32 - How to Write Documentation


Listen Later

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

...more
View all episodesView all episodes
Download on the App Store

Open Hardware Manufacturing PodcastBy Opulo

  • 5
  • 5
  • 5
  • 5
  • 5

5

10 ratings


More shows like Open Hardware Manufacturing Podcast

View all
MacBreak Weekly (Audio) by TWiT

MacBreak Weekly (Audio)

2,013 Listeners

The Amp Hour Electronics Podcast by The Amp Hour (Chris Gammell and David L Jones)

The Amp Hour Electronics Podcast

230 Listeners

The Vergecast by The Verge

The Vergecast

3,646 Listeners

Accidental Tech Podcast by Marco Arment, Casey Liss, John Siracusa

Accidental Tech Podcast

2,093 Listeners

Upgrade by Relay

Upgrade

1,192 Listeners

Making It With Jimmy Diresta, Bob Clagett and David Picciuto by I Like To Make Stuff

Making It With Jimmy Diresta, Bob Clagett and David Picciuto

1,674 Listeners

Cortex by Relay

Cortex

1,261 Listeners

Decoder with Nilay Patel by The Verge

Decoder with Nilay Patel

3,118 Listeners

The WAN Show by Linus Tech Tips

The WAN Show

1,103 Listeners

Home Assistant Podcast by HK Media

Home Assistant Podcast

64 Listeners

Syntax - Tasty Web Development Treats by Wes Bos & Scott Tolinski - Full Stack JavaScript Web Developers

Syntax - Tasty Web Development Treats

987 Listeners

Darknet Diaries by Jack Rhysider

Darknet Diaries

7,836 Listeners

Waveform: The MKBHD Podcast by Vox Media Podcast Network

Waveform: The MKBHD Podcast

5,904 Listeners

Brad & Will Made a Tech Pod. by Brad Shoemaker, Will Smith

Brad & Will Made a Tech Pod.

476 Listeners

Oxide and Friends by Oxide Computer Company

Oxide and Friends

47 Listeners