< Documentation < Patterns

A tutorial teaches the reader how to complete a project.

Tutorials should be:

  • clear about prerequisites
  • ordered
  • reproducible

Examples

Collections

Tools for creating tutorials

Description

Tutorials are lessons that take the reader through a series of steps to complete a project. Tutorials are learning oriented.[1]

Required

Introduction

The first section under the title should introduce the topic and audience of the page and provide a clear description of the outcome of the tutorial.

Prerequisites

The page should include a "Prerequisites" section that describes the required tools, knowledge, or other prerequisites required to complete the tutorial.

Numbered steps

Section headings should be numbered and represent a clear sequence of steps.

Working examples

Commands and examples should be tested for accuracy.

Review process

References

This article is issued from Mediawiki. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.