Writing for Implementers

Content

  • Only enough theoretical information to give some background and to help with troubleshooting
  • Often general description of equipment, parts, operation principles, maintenance
  • Often emphasis on mechanical operation
  • Emphasis on detail, but less than for expert

Organization

  • Sequential or chronological

Style/Tone

  • Active voice
  • Imperative mood, if instructing how to operate something
  • Standard terms and abbreviations may be used, although some definitions may be necessary
  • Formulae and equations should be limited; verbal explanations should always accompany them
  • Short sentences and paragraphs

Layout/Illustration

  • Illustrations, photos, blow-up diagrams
  • Charts, graphs, and photographs are detailed, but not as complex as for expert
  • Carefully labeled drawings
  • Lots of headings, white space, numbered steps, color, graphic techniques (boxes, lines)