Course Outline

Introduction

  • Creating Documentation that Gets Used

Requirements Gathering

  • How to Look at an Instruction Manual from the Eyes of the User
  • Gathering and Understanding Requirements (Internal and External)
  • What to Include in Technical Documentation and What to Leave Out

Planning

  • Planning a Technical Writing Project
  • Schedules and the Product Lifecycle

Writing

  • Writing a Minimal Viable Draft
  • Making Your Writing Understandable
  • The Importance of Iteration in the Writing Process

Structuring

  • Structuring a Document
  • Making Content Searchable

Appearance

  • Adding Illustrations and Diagrams
  • Formatting and Layout Techniques
  • Using Typography to Enhance Readability

Tools

  • Using Technical Documentation Tools and Templates

Revision

  • Optimizing the Technical Documentation Workflow
  • Formalizing the Review and Revision Process

Translation

  • Translation and the Translation Process

Publishing

  • Publishing a Technical Document

Post-Publishing

  • Obtaining Feedback from Users
  • Updating and Maintaining Technical Documentation

Summary and Conclusion

Requirements

  • No special requirements other than having a product a service that requires technical documentation.

Audience

  • Non-writers (e.g., developers, engineers, technical managers, designers, product and project managers, etc.)
 14 Hours

Delivery Options

Private Group Training

Our identity is rooted in delivering exactly what our clients need.

  • Pre-course call with your trainer
  • Customisation of the learning experience to achieve your goals -
    • Bespoke outlines
    • Practical hands-on exercises containing data / scenarios recognisable to the learners
  • Training scheduled on a date of your choice
  • Delivered online, onsite/classroom or hybrid by experts sharing real world experience

Private Group Prices RRP from £3800 online delivery, based on a group of 2 delegates, £1200 per additional delegate (excludes any certification / exam costs). We recommend a maximum group size of 12 for most learning events.

Contact us for an exact quote and to hear our latest promotions


Public Training

Please see our public courses

Provisional Upcoming Courses (Contact Us For More Information)

Related Categories