Skip to content

Template for a Tutorial

a_git_a edited this page Mar 28, 2023 · 26 revisions

to use this template with the formatting press the Edit button on the top right and copy the sections. You can edit all the steps below. Please don't edit the template directly unless you want to improve it

[ Edit: 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) ]

[ If applicable: Who is your audience? ]

[ Edit: how much time will it take? to complete your tutorial]

[ If applicable: guidelines or prerequisites (what do they need to know prior to starting the tutorial?) ]

[ Edit: First step ]

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

[ Edit: Part 1 ]

[ Edit: Part one instructions. ]

[ Edit: Part 2 ]

[ Edit: Part two instructions. ]

Tip: [ If applicable: place your tip here or anywhere else ]

[ Edit: Second Step ]

[ Edit: Explain the reasoning and expected result. ]

[ Edit if applicable: Part 1 ]

[ Edit if applicable: instructions ]

Wrap-up

[ Edit: Congratulations on completing this tutorial! (Edit this part as you feel, with your free-form congrats sentence) ]

Conclusion

[ Edit: Summarize important lessons you'd like users to take away from the tutorial. ]

What's Next?

[ Edit: 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