1.8 KiB
1.8 KiB
Tutorial Effectiveness Checklist
Use this checklist to ensure tutorials are clear, actionable, and effective for learning.
Step Clarity
- Each step has clear, actionable instructions
- Steps are numbered or otherwise clearly sequenced
- No ambiguous instructions
- Required actions are explicit (not implied)
- Steps are in logical order
Expected Results
- Expected outcome documented for each step
- Screenshots or output samples provided where helpful
- Success indicators are clear
- Readers know when step is complete
- Intermediate results are validated
Reproducibility
- Reader can complete tutorial independently
- All required information is provided
- No assumptions about prior setup
- Environment setup is documented
- Tutorial has been tested by someone unfamiliar with material
Troubleshooting
- Common issues are identified
- Solutions for common problems provided
- Error messages are explained
- Debugging guidance included
- Where to get help is documented
Learning Value
- Tutorial teaches stated concept clearly
- Hands-on practice reinforces learning
- Complexity is appropriate for target audience
- Builds on previous knowledge appropriately
- Connects to real-world applications
Engagement
- Introduction explains why tutorial matters
- Motivation is clear (problem being solved)
- Pace is appropriate (not too fast or slow)
- Checkpoints validate understanding
- Summary reinforces key takeaways
Accessibility
- Prerequisites are clearly stated
- Required skill level is appropriate
- No unexplained jargon
- Alternative approaches mentioned where relevant
- Accommodates different learning speeds