The Stack Overflow Podcast cover image

An Engineer's Field Guide to Great Technical Writing

The Stack Overflow Podcast

00:00

The Importance of Relationship Building

The difference between archaeology and detective work is the degree to which the subject is past tense. There's actually there's a really good example in Kubernetes documentation of the kind of forensic near term archaeology, let's call it that goes into technical writing. And if you look at the documentation for cluster DNS policy, all of that archaeology is summed up in a call out that's two sentences long. That's the kind of like eight hours of forensic work that goes into a two line sentence.

Transcript
Play full episode

The AI-powered Podcast Player

Save insights by tapping your headphones, chat with episodes, discover the best highlights - and more!
App store bannerPlay store banner
Get the app