« Back to Index

[Types of Documentation]

View original Gist on GitHub

Tags: #documentation #docs #guides #tutorials #reference #explanation

Types of Documentation.md

1. Tutorials
2. How-to guides
3. Explanation
4. Reference

Tutorials

A tutorial:

• is learning-oriented
• allows the newcomer to get started
• is a lesson

Analogy: teaching a small child how to cook

How-to guides

A how-to guide:

• is goal-oriented
• shows how to solve a specific problem
• is a series of steps

Analogy: a recipe in a cookery book

Explanation

An explanation:

• is understanding-oriented
• explains
• provides background and context

Analogy: an article on culinary social history

Reference

A reference guide:

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

Analogy: a reference encyclopaedia article