Course Outline

This seminar is a highly condensed version of a semester-long course on advanced technical communication that I taught at MIT. Some clients prefer a one-day seminar, while others prefer the two-day version.

In addition to the modules shown on this page, I also customize content to meet the needs of individual clients. For example, suppose engineers in your organization write a certain kind of monthly report. In this case, I'd ask the course organizer to send me a few sample monthly reports. From those samples, I'd create appropriate slides and exercises aimed at improving those monthly reports.

Students generally find the course fun, valuable, and exhausting. Expect to spend the day(s) writing furiously (though happily).

 
Day One
Module Title Tasks
Overview
  • Compare the writing process to the engineering process.
    • Active Voice
  • Convert passive voice sentences to active voice.
    		•
    Short Sentences
  • Reduce sentence length.
  • Eliminate unnecessary words.
  • Revise sentences for clarity.
    		•
    Strong Sentences
  • Use stronger verbs.
  • Pick concise, accurate words.
  • Transition gracefully between sentences.
    		•
    Jargon
  • Distinguish between jargon and common use.
  • Define new terms accurately.
    		•
    Lists
  • Learn to write effective lists.
  • Break down any task into useful steps.
    		•
    Descriptions
  • Compete in a two-person communication game.
  • Render faithful descriptions.
  • Learn a hierarchical description model.
    • Audience
  • Categorize your audience by eight different parameters.
  • Describe a technical topic for two very different audiences.
    		•
    Peer Reviews
  • Detect mistakes more readily.
  • Integrate writing and editing as an effective engineering process.
  • Edit your peers' documents and remain friends.
    		•
    Day Two
    Module Title Tasks
    Executive Summaries and Abstracts
  • Condense a long document into a neat little bundle.
    		•
    Fonts
  • Pick the right fonts for hard-copy and online doc.
    		•
    Tricks of Professional Writers
  • Learn pace.
  • Pick useful examples.
  • Understand tone.
  • Use Q&A format effectively.
  • Go beyond the obvious.
    		•
    Manuals
  • Evaluate five different styles of manuals.
    		•
    Specs
  • Evaluate the audience.
  • Define the areas to cover in the spec.
  • Write the spec accurately.
    		•
    Proposals
  • Evaluate the audience.
  • Specify design and methods.
  • Define contingencies.
    		•
    Email
  • Understand the essential flaws in many email messages.
  • Avoid flame wars.
  • Use the proper tone.
    		•