tutorial-patterns

Tutorial Patterns

Patterns for creating tutorials that take users from zero to success with minimal friction.

Purpose

• Structure tutorials for progressive learning
• Ensure users can verify success at each step
• Reduce drop-off by addressing common failures

---

Core Patterns

Pattern 1: Quickstart Structure

When to use: Getting users to first success in under 5 minutes.

Implementation:

# Quick Start

Get [feature] running in 5 minutes.

## Prerequisites
- [Tool] version X or higher
- [Credential/access] (get from [location])

## Steps

### 1. Install
```bash
npm install package-name

2. Configure

Create config.json:

{
  "apiKey": "your-key-here"
}

3. Run

npm run start

Expected output:

Server running on http://localhost:3000

Verify It Works

Open http://localhost:3000 - you should see [description].

Next Steps

• [Link to detailed configuration]
• [Link to advanced features]

**Benefits:**
- Users reach success quickly
- Clear verification at each step
- Natural progression to deeper content

### Pattern 2: Task-Oriented Guide

**When to use:** Explaining how to accomplish a specific goal.

**Implementation:**
```markdown
# How to [Accomplish Goal]

This guide shows how to [specific outcome].

## Before You Begin
You'll need:
- [Prerequisite 1] - [why needed]
- [Prerequisite 2] - [why needed]

## Steps

### Step 1: [Action Verb] the [Thing]

[Brief explanation of why this step matters]

```bash
[command]

You should see:

[expected output]

Note: If you see [error], try [fix].

Step 2: [Action Verb] the [Thing]

[Continue pattern...]

Verification

To confirm success:

1. [Check 1]
2. [Check 2]

Troubleshooting

Problem: [Common issue]

Cause: [Why it happens] Solution: [How to fix]

Problem: [Another issue]

Cause: [Why] Solution: [Fix]

**Benefits:**
- Goal-focused, not feature-focused
- Anticipates problems
- Clear success criteria