3min chapter

Signals and Threads cover image

Writing, Technically with James Somers

Signals and Threads

CHAPTER

How to Optimize the Presentation of Technical Documentation

When you look at some piece of code that has a lot of documentation in it, you sometimes feel like you're missing the forest for the trees. And I also wonder if there's something one could do at the level of the tooling to make things more navigable. What we maybe don't have so much of in technical documentation is genre. So when you open a newspaper, it's written in a converted pyramid style where you have the highest level facts up front and then it slowly gets more and more detailed. Once you figure out that's the style that newspaper articles are written in, you can approach them depending on what kind of day you want to have with that kind of article.

00:00

Get the Snipd
podcast app

Unlock the knowledge in podcasts with the podcast player of the future.
App store bannerPlay store banner

AI-powered
podcast player

Listen to all your favourite podcasts with AI-powered features

Discover
highlights

Listen to the best highlights from the podcasts you love and dive into the full episode

Save any
moment

Hear something you like? Tap your headphones to save it with AI-generated key takeaways

Share
& Export

Send highlights to Twitter, WhatsApp or export them to Notion, Readwise & more

AI-powered
podcast player

Listen to all your favourite podcasts with AI-powered features

Discover
highlights

Listen to the best highlights from the podcasts you love and dive into the full episode