Writing a Tutorial

A tutorial should have a clear goal and present step-by-step instructions to achieve that goal.

Example Tutorial

This introductory sentence should state the intent and goal of the tutorial. Keep it brief.

This next block should state any assumptions that you the writer are making. Present them in list form, for example:

This tutorial assumes:

Getting started

State any introductory steps in this section. These might include:

  • Downloading data
  • Creating a database

Other sections

In a single sentence, state what will be achieved in this section. Then list the steps the user needs to take:

  1. Step one
  2. Step two