Creating and Designing User-Friendly Technical Documents

Technical and complex products require written instructions (documentation) describing how they should be used. However, readers frequently find these manuals, help systems, or web-based instructions difficult to use. Documentation is often poorly organized and poorly presented, whether in print form or online. Participants will develop skills to identify inferior technical documents and techniques to develop superior ones.

Course Benefits:

Program participants will gain:
  • The ability to create usable documents that succeed in the workplace
  • Understanding of the entire document life cycle
  • Techniques for working with technical experts
  • Knowledge of what experts say about document design

Course Objectives:

  • Understand the benefits of audience and task analysis
  • Write clear instructions
  • Explore writing differences for online delivery
  • Understand graphic elements and page layout issues
  • Discover indexing methods that help users succeed
  • Identify problems and pitfalls in example documentation

Who Should Attend:

  • Technical communications and others who produce written or online documentation for a product
  • Programmers and engineers who develop products that require supporting documentation
  • Managers who oversee document production