Skip to content

How-To Guide template

Canonical template for the How-To Guide format.

# How to [accomplish specific task]
## Before you begin
- [Prerequisite: what the reader must already have or know]
- [Prerequisite: access, tool, or state required]
## Overview
[1-2 sentences: what this guide covers and what the reader will be able to do when done.]
## Step 1: [Action phrase]
[Brief explanation of why this step is needed.]
[Specific, concrete instruction.]
[What a successful outcome looks like at this step.]
## Step 2: [Action phrase]
...
## Troubleshooting
[Common failure point and what to do about it.]
## Next steps
[Where to go from here: related tasks, deeper reading, or what the reader just unlocked.]