Code Story episode
Compiler – Why Should You Write Technical Documentation?
Nov 17, 2021 · Season 5 · 31 min
Compiler Recast – Why Should You Write Technical Documentation?
Original episode: https://www.redhat.com/en/compiler-write-technical-documentation
Hey guys, getting close to Thanksgiving in the states. For today, I'm sharing another fantastic episode of the Compiler podcast, from Red Hat. As a reminder Compiler is a show hosted by tech veterans, discussing tech topics - big, strange and small.
On this particular episode - which is episode 8 - the topic of technical documentation is discussed. This is a fitting topic, given that the show is brought to you by Red Hat, which is the largest open source company in the world. The use cases for technical documentation for open source software seem pretty straight forward and obvious - if a developer or user needs to download a free, open source program, they will also need the correlated documentation so they can educate themselves on how to use the program.
In my experience, the need for technical documentation goes way beyond the boundaries of open source. Within the walls of a business, the need to share technical documentation around product architecture, entity relationships, DevOps workflow and even product strategy are absolutely critical in ensuring that everyone is on the same p age to move forward.
At the root, both types of technical documentation have the same goal - to inform the reader on how things should work. This episode was a great discussion on the topic, and I hope you enjoy Episode 8 of the Compiler podcast.
Checkout our episode stacks on Stacklist! https://stacks.codestory.co/
Advertising Inquiries: https://redcircle.com/brands
Privacy & Opt-Out: https://redcircle.com/privacy
More episodes
Keep listening
Topics
Explore related conversations
Startup engineering team structure that actually ships
How to structure a startup engineering team: the models that work at 5, 15 and 40 engineers, how to split teams, and the org mistakes that quietly slow delivery.
How to choose a tech stack for a startup
A decision framework for choosing a startup tech stack: what actually matters, which choices are reversible, and how to avoid the rewrite that eats your Series A.
Build vs buy: a decision framework for technical leaders
When to build software in-house and when to buy it: a build vs buy framework covering total cost of ownership, differentiation, switching costs and vendor risk.