Learn a step-by-step process for writing a quickstart guide to accompany a product or software.
Overview
Syllabus
Introduction
- Welcome
- Know what you want the guide to accomplish
- List steps: Sequence or separate tasks?
- Incorporate visuals into your quickstart guide
- Base your quickstart guide on your user manual
- Base your quickstart guide on input from users
- Address your user directly
- Identify the overall purpose of the guide by explaining the outcome
- Write clear headings
- Begin each step with a verb
- Provide context or notes before steps, not within them
- Use plain language
- Use consistent formatting
- Challenge: Revise a quickstart guide
- Solution: Revise a quickstart guide
- Ask a subject matter expert to review your quickstart guide
- Ask users to review your quickstart guide
- Next steps
Taught by
Leslie O'Flahavan