This course introduces the elements of technical writing and the process involved in creating effective technical documents. We will explore the distinctions between other writing types and the characteristics of impactful technical documents. We will guide you through the technical writing process, from planning and researching to drafting and revising. You will develop skillsets for tailoring content to the target audience, selecting the appropriate format, and using visuals and graphics effectively.
Learning Objectives »
- Understand technical writing and how it differs.
- Identify critical elements of technical writing.
- Explore the technical writing process.
- Identify and analyze target audiences.
- Plan and research technical documents.
- Effectively draft and revise documents.
Course Agenda
Foundation
- What is Technical Writing?
- Types of Technical Writing
- Technical Writing Frame
- Characteristics of Technical Documents
- Elements of Technical Writing
Framing
- Technical Writing Process
- Audience Targeting
- Fleshed-Out Frame
- Audience Analysis
- Purpose and Research
- Outlining and Mapping
- Drafting
- Illustrate
- Revise and Test
Facade
- Personalizing to the Audience
- Types of Audiences
- Targeting Multiple Audiences
- Formality
- Tone and Style
Finishing
- Revision Process
- Consistency
- Generative AI in Technical Writing
- Power Structure
- Active vs. Passive Voice
- Powerful Verbs
- Smothered Verbs
- Syntax and Pronoun Specificity
- Logical Flow
- Properly Placed Modifiers
- Parallel Structure
Fixtures
- Skimmer Friendly
- Headings
- Transitions
- Charts, Graphs, and Tables
- Images and Illustrations
- Extras
- Citations
