Documentation
There are 4 types of documentation:
1. Tutorials
- is learning-oriented
- allows the newcomer to get started
- is a lesson
Analogy: teaching a small child how to cook
2. How-to Guides
- is goal-oriented
- shows how to solve a specific problem
- is a series of steps
Analogy: a recipe in a cookery book
3. Explanation
- is understanding-oriented
- explains
- provides background and context
Analogy: an article on culinary social history
4. Reference
- is information-oriented
- describes the machinery
- is accurate and complete
Analogy: a reference encyclopaedia article
This is a summary of this article.