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
    LATEST ARTICLES
    Slideshow: 5 Hot Holiday Gifts for Tech Enthusiasts

    From cute electronic toys to VR gaming, here are 5 hot gifts to give to your special tech enthusiast this holiday season. Read More »

    What's Hot in Tech: AI Tops the List

    Like everything in technology, AI touches on so many other trends, like self-driving cars and automation, and Big Data and the Internet of Things... Read More »

    DevOp's Role in Application Security

    As organizations rush to release new applications, security appears to be getting short shrift. DevSecOps is a new approach that holds promise. Read More »

    STUDY GUIDES
    Java Basics, Part 1

    Java is a high-level programming language. This guide describes the basics of Java, providing an overview of syntax, variables, data types and... Read More »

    Java Basics, Part 2

    This second Study Guide describes the basics of Java, providing an overview of operators, modifiers and control Structures. Read More »

    The 7 Layers of the OSI Model

    The Open System Interconnection (OSI) model defines a networking framework to implement protocols in seven layers. Use this handy guide to compare... Read More »