Optimizing your documentation with the help of technical support

  • Authors:
  • Rob Pierce

  • Affiliations:
  • IBM Rational Software, Lexington, MA

  • Venue:
  • Proceedings of the 21st annual international conference on Documentation
  • Year:
  • 2003

Quantified Score

Hi-index 0.00

Visualization

Abstract

Maintaining technical support is costly. Better documentation means more successful customers AND lower costs of supporting a product.Most companies have two bodies of technical information that in many organizations remain entire to themselves. The information presented in the company's documentation deliverables and in their technical support data repository are not always consistent. There can be a real issue of redundancy and inaccuracy between these two areas of information.It may be common knowledge that working with Technical Support can improve your documentation deliverables, in theory. But in practice, there is frequently not a seamless integration of technical information, unless mandated by management for documentation groups and technical support groups to work together.This paper is a case study of this situation and presents some ideas on how to improve the probability of ensuring that one unified body of information is presented to customers. It is derived from experiences gained through working with a large body of technical content for a widely-used product, that includes application programming interface (API) reference information in the form of a Help system and a 900 page pdf file that ship with the product and access to a solutions database that is accessible from the Internet, given proper authentication.