In this course, you will learn the fundamental skills required be a successful technical writer. We’ll discuss the various types of technical documentation and how to create them by developing clear, concise content.
This two-day course includes exercises, handouts, and hands-on labs to provide you with hands-on experience in subject matter expert interviews, audience analysis, documentation processes, document review cycles, and editing. Contact us to learn more about on-site training and custom training solutions.
Day 1 Course Outline
Technical Writing Fundamentals (Part 1)
- The Business Case for Technical Writing
- Characteristics of Technical Writing Skills
- Applications of Technical Writing
- Examples of Technical Writing
- Audience Analysis
- Targeting Reader Needs
Technical Writing Fundamentals (Part 2)
- Parts of Speech
- Active vs. Passive Voice
- Simple vs. Complex Language
- Present vs. Past vs. Future Tense
- Formal vs. Informal Style
- Using Clear, Concise Language
- Addressing Common Errors in Technical Writing
- Summary: Tips to Help You Write More Clearly
- Ethical Principles for Technical Communicators
Day 2 Course Outline
Technical Writing Strategies
- The Technical Writing Process
- Describing the Document’s Purpose—The Technical Brief
- Subject Matter Expert (SME) Interviewing Techniques
Technical Writing Tasks
- Explaining a Process
- Communicating Visually
- Using Effective Formats
- Writing a Table of Contents
- Writing an Index
- Writing a Summary
- Writing a Glossary
- Creating Manuals & Documentation
- Editing Your Own Documentation
- Proofreader’s Checklist