Overview
This instructor-led, live training (online or onsite) is aimed at persons who wish to write technical documentation but lack the experience of a trained technical writer.
By the end of this training, participants will be able to:
- Produce technical content that’s accurate and user-friendly.
- Transform complex product information into readable user-focused content.
- Apply tools and techniques to maximize writing efficiency.
- Understand and oversee the different phases of a writing project, including writing, revision, translation and publication.
- Complete writing projects on time and per requirements.
Format of the Course
- Interactive lecture and discussion.
- Lots of exercises and practice.
- Hands-on practice in a live-lab environment.
Course Customization Options
- To request a customized training for this course, please contact us to arrange.
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.)
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