Technical Writing: Quick Start Guides

Go to class
Write Review

Free Online Course: Technical Writing: Quick Start Guides provided by LinkedIn Learning is a comprehensive online course, which lasts for Less than 1 hour of material. The course is taught in English and is free of charge. Upon completion of the course, you can receive an e-certificate from LinkedIn Learning. Technical Writing: Quick Start Guides is taught by Leslie O'Flahavan.

Overview
  • Learn a step-by-step process for writing a quickstart guide to accompany a product or software.

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