Thank you for sending your enquiry! One of our team members will contact you shortly.
Thank you for sending your booking! One of our team members will contact you shortly.
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
