Class Central is learner-supported. When you buy through links on our site, we may earn an affiliate commission.

LinkedIn Learning

Technical Writing: Quick Start Guides

via LinkedIn Learning

Overview

Syllabus

Introduction
  • Welcome
1. Components of a Quickstart Guide
  • Know what you want the guide to accomplish
  • List steps: Sequence or separate tasks?
  • Incorporate visuals into your quickstart guide
2. How to Develop Your Quickstart Guide
  • Base your quickstart guide on your user manual
  • Base your quickstart guide on input from users
3. Best Writing Practices for a Quickstart Guide
  • 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
4. Check Your Quickstart Guide for Accuracy and Usefulness
  • Ask a subject matter expert to review your quickstart guide
  • Ask users to review your quickstart guide
Conclusion
  • Next steps

Taught by

Leslie O'Flahavan

Reviews

4.7 rating at LinkedIn Learning based on 636 ratings

Start your review of Technical Writing: Quick Start Guides

Never Stop Learning.

Get personalized course recommendations, track subjects and courses with reminders, and more.

Someone learning on their laptop while sitting on the floor.