Tutorial Template

Note

This is a template: copy and edit the text with your tutorial topic.

Introduce the task or procedure that this tutorial covers. Provide context on why it is important and when it should be performed.

What you will do

Describe the end result that learners will produce by following the tutorial. Emphasise the tangible outcome so they know what success looks like.

What you need

List the skills, tools, accounts, datasets, or starting code that learners must have in place before beginning. Keep the list short and link to supporting how-to guides if setup is lengthy.

Estimated time

Give a realistic time range so readers can plan the session.

Prepration

Outline any preparatory steps that ensure the environment is ready for the walkthrough. Use a numbered list if multiple actions are required.

Steps

Guide the learner through the experience one step at a time. Keep directions linear, include each action they must perform, and call out the expected result of every step.

Step 1 description and expected outcome
Step 2 description and expected outcome

…

Check your progress

Show the learner how to validate that they achieved the intended outcome. Provide sample command output, screenshots, or acceptance checks as needed.

Wrap up

Summarise what the learner accomplished and reinforce the key concepts they practised.

Next steps

Suggest follow-on tutorials, how-to guides, or explanations that help the learner deepen their understanding or apply the new skill.

If you get stuck

Offer guidance on where to seek help, how to reset the environment, or which troubleshooting resources to consult.