Code[ish]

The Agony and Ecstasy of Maintaining Good Documentation


Listen Later

With the explosive growth of people using, and contributing to, open source projects over the last decade, more and more of us are spending their time reading, writing, and understanding documentation.

Heroku's Dev Center is the central hub of documentation for Heroku, covering everything from getting started, to how Heroku works, to extending the platform. It acts as a manual for the entire platform, spanning an enormous number of topics and tools.

Stephen Barlow, lead strategist for Dev Center, joins Heroku designer / developer Charlie Gleason to discuss why good documentation is so important—from some of the common challenges you and your team might face while writing them, to advice for rationalising and improving your documentation workflow.

Tune in to learn why good docs aren't just good—they're great.

Links from this episode
  • Heroku Dev Center
  • Heroku Buildpacks
  • Rust
  • Create React App
  • Write The Docs Conference
  • Prettier
  • Typescript
  • Git hooks and Husky
  • Runbooks
  • Heroku Changelog
  • Stack Overflow
...more
View all episodesView all episodes
Download on the App Store

Code[ish]By Heroku from Salesforce

  • 4.7
  • 4.7
  • 4.7
  • 4.7
  • 4.7

4.7

18 ratings


More shows like Code[ish]

View all
Motley Fool Money by The Motley Fool

Motley Fool Money

3,235 Listeners

The Changelog: Software Development, Open Source by Changelog Media

The Changelog: Software Development, Open Source

288 Listeners

Up First from NPR by NPR

Up First from NPR

56,980 Listeners

CoRecursive: Coding Stories by Adam Gordon Bell - Software Developer

CoRecursive: Coding Stories

188 Listeners

Elis James and John Robins by BBC Radio 5 Live

Elis James and John Robins

328 Listeners

Tech Lead Journal by Henry Suryawirawan

Tech Lead Journal

14 Listeners