Tutorial
A tutorial connects products to real-world scenarios to meet a user’s goal.
Template
We have a pre-built template that helps you follow our general structure and content guidelines.
You can copy the file directly or - if you have Hugo installed on your local machine - you can run the following command:
$ hugo new content --kind tutorial {new_file_location}
In practice, that might look like:
$ hugo new content --kind tutorial content/workers/tutorials/new-tutorial.md
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
tutorial
Structure
Required components
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 components
Screenshots
Boundaries
Examples
Additional information
We have a tool that pulls together everything labeled with <pcx_content_type: tutorial>: Tutorials