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?
    Small Business Marketing's Greatest Hits

    The following compilation of small business marketing tips highlights some of the expert advice published over at Small Business Computing. Read More »

    Taking Ownership through Digital Governance

    Taking ownership of our own misjudgments or simple forgetfulness takes a healthy amount of humility and some honest self-assessment. Yet sometimes... Read More »

    Have We Become a World of Addicts?

    It's hard to imagine our lives without smartphones. But people who suffer separation anxiety when they don't have their phones nearby may be in... Read More »

    QUICK REFERENCE
    5 Best Cloud Storage Services

    With cost and security in mind, we look at five cloud storage options that will suit the needs of most home and SMB owners. Read More »

    Windows 10 Tips for Desktop PC

    Five basic tips to help you customize Windows 10 on your desktop PC. Read More »

    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 »