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?
    11 Tips to Boost Your Wi-Fi Signal

    It's not just your lawnmower and household tools that your neighbor won't return. Our top picks include everything from updating device firmware... Read More »

    Interesting Times: Transformation in the IT Channel

    Business transformation will remain the buzzword of the moment as channel firms continue to assess the direction of their companies in the age of... Read More »

    What is a Virtual Private network (VPN)?

    Companies and organizations will use a VPN to communicate confidentially over a public network and to send voice, video or data. Read More »

    QUICK REFERENCE
    29 Free Android Apps for Cash-Strapped Students

    From wacky alarm clocks to lecture hall tools and after class entertainment, these Android apps are a good fit for a student's life and budget. Read More »

    Network Fundamentals Study Guide

    A network is a group of two or more computer systems or devices, linked together to share resources, exchange files and electronic communications.... Read More »

    Computer Architecture Study Guide

    This Webopedia  study guide describes the different parts of a computer system and their relations. Read More »