Skip to content

Template for a Tutorial

a_git_a edited this page Mar 24, 2023 · 26 revisions

Start with a goal - what will people learn (what problem are you solving? What value is this tutorial providing? How the people will benefit from the completion of your tutorial? (keep this part very short and as straightforward as possible - one sentence is optimal))

Who is your audience?

How much time will it take?

Guidelines or prerequisites (what do they need to know?)

First step

When asking users to carry out a step, explain the reasoning behind the action and the expected result.

Hello world

Part 1

Part one instructions.

Part 2

Part two instructions.

TIP place your tip here

Second Step

Explain the reasoning and expected result.

Part 1

Instructions

Wrap-up

Congratulations on completing this tutorial! (Edit this part as you feel)

Conclusion

Summarize important lessons you'd like users to take away from the tutorial.

What's Next

Help users along their journey by providing the next steps - these might be recommended reading, supplementary resources, or even another tutorial.

Clone this wiki locally