Technical Documentation

Technical documentation means explaining a technical product, such as software, high-tech manufacturing equipment and test equipment, with great detail and clarity.

Technical documentation is rarely considered interesting but it certainly should be easy to read, easy to understand (for the target audience), and easy to locate information.

Technical documentation includes:

  • User manual
  • Reference manual
  • Programmer’s guide
  • On-line help
  • On-line knowledge base
  • Quick-start manual
  • Tutorials
  • Classroom-based technical training
  • Online technical training
  • Audio/visual material.

This covers some of the most common types of technical documentation.

Technical marketing material is a little different, but certainly technical documentation does serve a marketing function.