Writing, Technically with James Somers
Signals and Threads
00:00
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.
Transcript
Play full episode
