By the way, I like the following approach as it methodically covers the reasons 
why someone would look into documentation: 
[https://www.divio.com/blog/documentation](https://www.divio.com/blog/documentation)

The main takeaway is that people looking into documentation have different 
needs and you need different articles for different needs. Quoting the article:

# 1\. Tutorial

  * Learning oriented
  * Allows newcomer to get started
  * is a lesson



Analogy: Teaching a small child how to cook

Comment: with have that in [tutorial 1](https://nim-lang.org/docs/tut1.html) 
and [2](https://nim-lang.org/docs/tut2.html)

# 2\. How-to guides

  * Goal-oriented
  * show to solve a specific problem
  * is a series of steps



Analogy: a recipe in a cookbook

Comment: The [cookbook](http://nim-cookbook.btbytes.com/) was supposed to do 
that. @miran [Nim basics](https://narimiran.github.io/nim-basics/) and 
@kaushalmadi [Scripter's notes](https://scripter.co/notes/nim/) have some parts 
that are goal oriented and some that are more explanation.

# 3\. Explanation

  * Understanding-oriented
  * explains
  * provides background and context



Analogy: an article on culinary social history

@miran [Nim basics](https://narimiran.github.io/nim-basics/) and @kaushalmadi 
[Scripter's notes](https://scripter.co/notes/nim/) are mostly explanations 
about type system, variables, control-flow with how-to mixed in

# 4\. Reference

  * information-oriented
  * describes the machinery
  * is accurate and complete



Analogy: a reference encyclopaedia article

Comment: This is the [manual](https://nim-lang.org/docs/manual.html)

Reply via email to