11. The agony and ecstasy of maintaining good documentation

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

Episode source