| Technical Writing for IT Professionals |
ID: DTTWri | Course Length:3 | Company Name:Choquette Technology Associates Inc.
|
|
Module 0: Fundamentals of Technical Writing |
- The Writing Process
- Understanding Your Writing Style
- The Path To Clarity and the Elimination of Ambiguity
- The Active and the Passive Voice
- Wording: Precision Versus Ambiguity
- Eliminating Jargon
|
|
Module 1: Planning the Document |
- The Difference Between Educational and Technical Documents
- Defining the Purpose and Goals of the Document
- Using Style Guides
- Defining the Document Structure
- Using Storyboarding for Long Documents
- Overview of the Document Production Process
|
|
Module 2: Transitions and Flow |
- The Whole Document
- Transition Words and Their Impact On Flow
- Using Headings and Sub-headings
- Using Numbered and Bulleted Lists
- Using Parallel Structures
- Using Paragraphs
|
|
Module 3: Setting Up a Template |
- Creating the Styles in Word
- Ensuring the Integrity of Styles
- Planning for Bulleting and Numbering
- Planning for Tables and Cells
- Planning the Reference Structure
|
|
Module 4: Creating Macros |
- Automation Overview
- Allocating Keyboard Shortcuts
- Creating Formatting Macros
- Creating Support Macros
|
|
Module 5: Effective Writing |
- Understanding Purpose, Goals and Target Audience
- The Importance of the Target Audience
- Beginning and Endings
- Subject Headings
- Directing the Message To the Reader
|
|
Module 6: Effective Topics |
- Topic Overviews
- Using Images in Text
- Using Graphs and Images
- Ensuring Effective Intra-topic Flow
|
|
Module 7: Preparing for Print |
- Proofreading the Document
- Finalizing the Document
- Printing the Document
- Preparing for Delivery
|
|
Module 8: Debrief – Reviewing the Process |
|