Skip to content

Template for a Tutorial

a_git_a edited this page Mar 28, 2023 · 26 revisions

to use this template, copy it and edit all the sections below, please don't edit the template directly unless you want to improve it

Start with a goal - what will people learn (what problem are you solving? How the will people benefit from the completion of your tutorial? Short and as straightforward as possible)

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.

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, with your free-form congrats sentence)

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.

Checklist before publishing

  • Is the goal clear and can be found within the first 30 seconds of opening your tutorial?
  • Are the steps clear and actionable for accomplishing the task your reader needed help with?
  • Is it possible to complete your tutorial within 15-30 minutes?
  • Do you have at least 1-2 images/visuals/media in your tutorial?
  • Did you spell-check and proofread? Grammarly
  • Is it easy to read? Hemingway. Quillbot is good for fluency and paraphrasing.
  • Did you check and fix the accessibility issues? WAVE
  • Is there a Call to Action / Next Steps?

Clone this wiki locally