Documentation

Instructions for using a computer device or program. Documentation can appear in a variety of forms, the most common being manuals. When you buy a computer product (hardware or software), it almost always comes with one or more manuals that describe how to install and operate the product. In addition, many software products include an online version of the documentation that you can display on your screen or print out on a printer. A special type of online documentation is a help system , which has the documentation embedded into the program. Help systems are often called context-sensitive because they display different information depending on the user’s position (context) in the application.

Documentation is often divided into the following categories:

  • installation: Describes how to install a program or device but not how to use it.
  • reference: Detailed descriptions of particular items presented in alphabetical order. Reference documentation is designed for people who are already somewhat familiar with the product but need reminders or very specific information about a particular topic.
  • tutorial: Teaches a user how to use the product. Tutorials move at a slower pace than reference manuals and generally contain less detail.
  • A frequent lament from computer users is that their documentation is inscrutable. Fortunately, this situation is improving, thanks largely to advances in help systems and online tutorials. These forms of documentation make it much easier to deliver the specific information a user needs when he or she needs it.

    Webopedia Staff
    Webopedia Staff
    Since 1995, more than 100 tech experts and researchers have kept Webopedia’s definitions, articles, and study guides up to date. For more information on current editorial staff, please visit our About page.

    Related Articles

    ScalaHosting

    ScalaHosting is a leading managed hosting provider that offers secure, scalable, and affordable cloud VPS solutions for businesses. It claims to change the status...

    Data Visualization

    Data visualization is the graphic representation of data so that analysts, readers, clients, and stakeholders can more easily see the implications of the raw...

    RSA SecurID

    RSA SecurID is multi-factor authentication (MFA) technology used to protect network resources, such as applications and websites. Its purpose is to mitigate risk and...

    Logo

    A logo is a symbol, mark, or other visual element that a company uses in place of or in conjunction with its business title....

    ScalaHosting

    ScalaHosting is a leading managed hosting provider that offers secure, scalable, and affordable...

    HRIS

    Human resources information system (HRIS) solutions help businesses manage multiple facets of their...

    Best Managed Service Providers...

    In today's business world, managed services are more critical than ever. They can...