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.)
Testimonials (5)
I am getting the correct level of understanding I need to assist in my day to day work
Wasfi Adams
Course - Impacted Function Point (IFP)
The trainer was super engaging and made sure we understand through questioning and affirmations. Even though the content was overwhelming, the trainer broke it down well and made content easily accessible for later reference.
Zaid Amerika
Course - Unit of Software Measurement Parameterization (UMSP)
the examples the trainer used in each subject which made it easier to understand
huda Alyassi - Dubai Government Human Resources Dept.
Course - Adobe XD
Trainer was really kind and knowledgeable, going the extra mile to explain things that I didn't know
Felix - Microchip Technology Inc
Course - Embedded C Application Design Principles for Automotive Professionals
Everything was built up from a basic level while progressing quick enough to prevent anyone getting bored.