This post, from September 3rd, 2013, delves into the art of writing technical documentation, specifically for programming languages and libraries. The author expresses love for great documentation that anticipates and answers questions. They emphasize the connection between writer and reader and the satisfaction of helping someone understand new concepts. The post discusses the importance of documentation as a teaching tool, providing valuable insights on how to effectively write documentation. It critiques ineffective documentation practices like directing users to read source code or tests. The author emphasizes the importance of documentation in guiding users from novice to expert status. Unique insights include comparing documentation to teaching and discussing the elements of good documentation composition.
https://stevelosh.com/blog/2013/09/teach-dont-tell/