TLDR · PROGRAMMING, DESIGN & DATA SCIENCE

EXAMPLES ARE THE BEST DOCUMENTATION

rakhim.exotext.com2 min read

Summary from the TLDR newsletter

Technical documentation is mostly aimed at people deeply immersed in the ecosystem. However, many developers have to juggle a lot of 'worlds' in their heads daily. It takes a lot of mental energy to restore context and understand what is going on when jumping between projects, languages, and frameworks. Examples are great because a lot of developers look at docs simply because they need to quickly find out how to do something. Tutorials are often helpful, not because of the walkthrough, but because they contain examples.