 - In computer hardware and software product development, documentation is the information that describes the product to its users. It consists of the product technical manuals and online information (including online versions of the technical manuals and help facility descriptions). The term is also sometimes used to mean the source information about the product contained in design documents, detailed code comments, white papers, and blackboard session notes.
The term is derived from the idea that engineers and programmers "document" their products in formal writing. The earliest computer users were sometimes simply handed the engineers' or programmers' "documentation." As the product audience grew, it became necessary to add professional technical writers and editors to the process. Today, IBM and other companies look at developing product information based on what users actually need to do when using the product. In this task-oriented view, product information can be divided into and sometimes physically organized into these task categories: evaluating, planning for, setting up or installing, customizing, administering, using, and maintaining the product. Documentation is now often built directly into the product as part of the user interface and in help pages. Printed technical manuals are increasingly available at company Web sites in the form of Adobe Acrobat Portable Document Format (PDF) files or in HTML pages. IBM and Microsoft are among the world's largest publishers.
| LAST UPDATED: |
01 Mar 2007
|
 |
Read more about documentation:
|
|
Do you have something to add to this definition? Let us know.
Send your comments to techterms@whatis.com
|
 |
 |
| |
RELATED CONTENT
 |
Manage component dependencies for improved system quality
Too much coupling of code within a system makes the system hard to understand, integrate, extend, and test. By managing dependencies, you can prevent...
|
|
Survey: Agile interest high, but waterfall still used by many
While there's a strong interest in new software development techniques, SearchSoftwareQuality.com's recent survey found that many still follow...
|
|
Continuous integration reduces bugs, increases productivity
Development teams can use continuous integration (CI) to find and fix bugs, share knowledge, and generally work better together, says Agile coach...
|
|
|
|
| |
RELATED GLOSSARY TERMS
| Terms from Whatis.com − the technology online dictionary |
|
build tool
(SearchSoftwareQuality.com)
A build tool is a programming utility that automates a software build task, such as ensuring that the proper source code files are compiled and that...
|
|
development environment
(SearchSoftwareQuality.com)
In computer program and software product development, the development environment is the set of processes and programming tools used to create the...
|
|
|
