Technical Documentation for Non-Writers Certificate for Maryam...
Add to LinkedIn
Certificate ID:
671291
Authentication Code:
f9683
Certified Person Name:
Maryam Hanafiah
Trainer Name:
Vaibbhav Varshney
Duration Days:
2
Duration Hours:
14
Course Name:
Technical Documentation for Non-Writers
Course Date:
2022-03-24 09:30 to 2022-03-25 16:30
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