Skip to content

Guides

Guides help readers accomplish a concrete goal. Each guide should state its prerequisites, provide an ordered procedure, show how to verify success, and identify likely failure modes.

  1. State the outcome and prerequisites.
  2. Give the minimum sequence of actions.
  3. Show expected results at important checkpoints.
  4. Link to relevant concepts and reference pages instead of repeating them.