Should consist of the following four parts:
Tutorials
Learning-Oriented
Lessons that take the reader by hand through a series of steps to complete a project.
How-To Guides
Problem-Oriented Guides that take the reader through the steps required to solve a common problem.
- series of steps
- focus on the goal
- addressing a specific question
- no unnecessary explanations
- flexibility
- practical usability
- good naming (How to xxx)
Reference
Information-Oriented Technical descriptions of the machinery and how to operate it.
- structure
- consistency
- description
- accuracy
Discussions
Understanding-Oriented Explanations that clarify and illuminate a particular topic.
- giving context
- explaining why
- multiple examples, alternative approaches
- making connections
- no instruction or technical description