Overview

Table of Contents

What are tutorials?

Tutorials are lessons that take the reader by the hand through a series of steps to complete a project of some kind. They are what your project needs in order to show a beginner that they can achieve something with it. They are wholly learning-oriented, and specifically, they are oriented towards learning how rather than learning what.

— Divio Documentation System

Tutorials are written by the Erebor team for the Erebor team. They reflect current system behavior and are the source of truth for how Erebor employees should accomplish tasks in our platform.

Good tutorials have the following properties:

  1. Image-heavy — pictures with arrows >> long paragraphs explaining behavior. You should have an image for each step of the tutorial.
  2. They work — tutorials should be written to codify existing behavior, not reflect aspirational work
  3. They rehash basics — you should not assume that users are coming in with system access or prior knowledge