Tutorial

A tutorial is a practical lesson that takes you from a clear starting to ending point.

The goal is to connect products to real-world scenarios to meet a user’s goal.

Note

If you are unsure about when to categorize something as a how-to or tutorial, remember:

Tutorials are typically longer form and contain multiple steps, usually involving multiple products, and help users connect products to real-world scenarios.

A how-to helps a user complete a singular task within a single product.

Guidelines

A tutorial is:

• User-focused
• Aligned to a user's goal or job-to-be-done
• Descriptive and guiding

A tutorial can:

• Describe how to integrate with a third party
• Be delivered in the Cloudflare dashboard
• Describe how to set up multiple products to complete a single job-to-be-done

A tutorial is not:

• Product configuration information, how-to (or any of the other content types)
• How to complete a task in the UI or API
• A dumping ground for screenshots
• Content with no end goal or job-to-be-done

Tone

Guiding, straightforward, educational, authoritative

content_type

pcx_content_type: tutorial

For more details, refer to pcx_content_type.

Components

Most used

• GitHubCode
• LastReviewed
• ListTutorials

Required

Title: Short verb phrase in second-person imperative.

Context: An introductory paragraph on the user's goal or job-to-be-done and how they will accomplish that in the tutorial. Consider including the intended audience for the tutorial. Refer to Context for more information.

Consider the user story framing: "As a ___, I want to ___ so I can ___."

Steps: Numbered steps that complete a task.

Optional

Notes/warnings

Examples

Screenshots

Links

Boundaries

Examples

Workers Tutorials