Webopedia on Google+Webopedia on TwitterWebopedia on FacebookTech Bytes Blog
Main » TERM » D »

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.

     

     

     







    TECH RESOURCES FROM OUR PARTNERS
    DID YOU KNOW?
    Who's Moving Ahead in Cloud Computing?

    The future remains, well, cloudy. But either way: Amazon, look out. Microsoft is gaining fast. Read More »

    Hype Versus Action in the Developer's World

    Often times technologies start as hype but with time become adopted. As a developer or technologist, it is worth reading the hype and knowing the... Read More »

    Microsoft Hyper-V Network Virtualization Q&A

    The top 5 Hyper-V questions with answers provided by Nirmal Sharma, a MCSEx3, MCITP and Microsoft MVP in Directory Services. Read More »

    QUICK REFERENCE
    Webopedia Polls

    Webopedia Polls: Is iPhone 6 or iWatch on your list? Read More »

    How to Create a Desktop Shortcut to a Website

    This Webopedia guide will show you how to create a desktop shortcut to a website using Firefox, Chrome or Internet Explorer (IE). Read More »

    Flash Data Storage Vendor Trends

    Although it is almost impossible to keep up with the pace of ongoing product releases, here are three recent highlights in the flash data storage... Read More »