J. G. Levitt Professional Development

Copyright 2017

jalevitt@cableone.net


www.jglevitt.com

Intended For 


This course is intended for people seeking to develop or improve effective technical writing skills at the beginning or intermediate levels.


Prerequisites


Participants are expected to be well experienced in basic grammar and writing skills, including sentence and paragraph development, spelling, and punctuation.

Technical Writing  Essentials Course

Primary Goal


The primary goal of this course is to review and practice writing techniques for making any technical content easy to read, understand, act upon, and remember.  Special emphasis is given to techniques for writing clear instructions and procedures.


Learning Objectives 


  1. Analyzing and identifying audience needs effectively
  2. Organizing technical content to covey the message clearly and logically
  3. Identifying information types, selecting the best corresponding presentation style for each, and organizing the content in logical sequencing
  4. Mastering higher-level writing skills to improve correctness, clarity, and professionalism of content (including use of active and passive voice, parallel structure, clear pronoun references, avoidance of subject and verb interruptions, and more)
  5. Writing clear, usable instructions and procedures
  6. Designing an effective layout and style guide for technical documents
  7. Proofreading and editing technical documents effectively



Comprehensive, Professional Book Provided


Participants receive a 75-page instructional book that provides hands-on experience and serves as a comprehensive reference for future use.  The text reflects current business trends.


Contents for Text-Workbook

Technical Writing Essentials


CHAPTER 1. DEFINE THE TECHNICAL WRITING PROCESS



CHAPTER 2. PLAN: DETERMINE DOCUMENT PURPOSE, AUDIENCE, AND REQUIREMENTS



CHAPTER 3. RESEARCH, CLUSTER IDEAS, IDENTIFY READER BENEFITS, AND SELECT AN ORGANIZATIONAL PATTERN



CHAPTER 4. DRAFT AND MAP THE CONTENT



CHAPTER 5. USE GRAPHICS TO CLARIFY DETAILS



CHAPTER 6. WRITE CORRECTLY, COHERENTLY, AND CLEARLY



CHAPTER 7. WRITE CLEAR INSTRUCTIONS AND PROCEDURES



CHAPTER 8. DEVELOP AN EFFICIENT DOCUMENT DESIGN



CHAPTER 9. REVIEW KEY ELEMENTS OF SHORT REPORTS



CHAPTER 10. REFINE YOUR DOCUMENT: PROOFREAD AND EDIT



Supplemental Technical Writing Essentials Resource Materials


Technical Writing Essentials Appendix Items


  1. Course Writing Project
  2. Template for Planning and Organizing a Technical Document
  3. Basic Flowcharting Fundamentals
  4. Technical Writing Information Resources
  5. Final Technical Document Checklist


Technical Writing Essentials: Companion CD Supplements


  1. Template for Planning and Organizing a Technical Document
  2. Using Numbers Correctly (in figures or written out)
  3. Comparison and Contrast Techniques
  4. International Localization: Structure Problems to Avoid
  5. Citing Sources in a Bibliography
  6. Basic Grammar and Punctuation Elements
  7. Technical Writing Strategies for the Web
  8. Revise Draft Exercise