Documentation design based upon intuitive feature taxonomy and use logging

  • Authors:
  • Hal Berghel;David Roach

  • Affiliations:
  • Center for Artificial Intelligence and Expert Systems, University of Arkansas;Center for Artificial Intelligence and Expert Systems, University of Arkansas

  • Venue:
  • SIGDOC '90 Proceedings of the 8th annual international conference on Systems documentation
  • Year:
  • 1990

Quantified Score

Hi-index 0.00

Visualization

Abstract

Although the quality of documentation of office automation software has increased significantly in the past few years, current offerings are not without problems. Those difficulties which have to do with the design and organization of the documentation are addressed in this paper.To illustrate, consider the following situations: 1) the command and control information which is commonly needed is either omitted or hard to find on the 'command card' or 'keyboard template' provided by the vendor, 2) the command or control information which we intuitively feel should be discussed in one section of the manual is actually located in an unrelated section, 3) the manual's table of contents does not seem to correspond well with the functional characteristics of the product, 4) the most appropriate command is not to be found in the manual's index, and 5) the 'help' facility frequently wastes rather than conserves time by providing the user with inappropriate alternatives. We maintain that these sorts of obstructions arise in many cases because insufficient attention has been given to an common sensical and intuitive analysis of the product's functionality as well as empirical use studies. We describe how these difficulties may be overcome by appeal to research results reported in the literature. Word processing software will be used to illustrate the technique.