088: //todo: documentation episode artwork

EPISODE · Aug 17, 2022 · 58 MIN

088: //todo: documentation

from Working Code · host Adam Tuttle, Ben Nadel, Carol Hamilton, Tim Cunningham

SponsorsAudible - get a free audiobook from Audible with no strings attached at https://workingcode.dev/audibleThis week on the show, the crew talks about documentation. Yay! As developers, there's no doubt that we all love consuming great documentation - especially for APIs. But, nary a one of us enjoys the process of creating documentation. Except maybe Adam, who's oddly passionate about communication. For the rest of us, however, documenting our choices and our subsequent outcomes feels a bit of a slog. It's never clear when we should be writing documentation; it's never clear what we should be documenting; and, it's never clear just how much detail we need to include. Sometimes, ironically, it seems that the more thoroughly we document a topic, the more likely it is to be misunderstood. So, that's awesome!Follow the show and be sure to join the discussion on Discord! Our website is workingcode.dev and we're @WorkingCodePod on Twitter and Instagram. New episodes drop weekly on Wednesday.And, if you're feeling the love, support us on Patreon.With audio editing and engineering by ZCross Media.

Episode metadata supplied by the publisher feed · Published Aug 17, 2022

Embed this episode

Read the show notes online: https://workingcode.dev/episodes/088-todo-documentation/

Distinct summary based on available episode metadata or transcript content.

NOW PLAYING

088: //todo: documentation

0:00 58:44

No transcript for this episode yet

We transcribe on demand. Request one and we'll notify you when it's ready — usually under 10 minutes.

No similar episodes found.

Frequently Asked Questions

How long is this episode of Working Code?

This episode is 58 minutes long.

When was this Working Code episode published?

This episode was published on August 17, 2022.

Can I download this Working Code episode?

Yes. Use the download control on the episode player to save the publisher-provided media file.
URL copied to clipboard!