documentation


Also found in: Dictionary, Thesaurus, Medical, Acronyms, Wikipedia.

documentation

1. the furnishing and use of documentary evidence, as in a court of law
2. Computing the written comments, graphical illustrations, flowcharts, manuals, etc., supplied with a program or software system
Collins Discovery Encyclopedia, 1st edition © HarperCollins Publishers 2005

Documentation

Any information that records the prior history of an existing building or site; such as maps, site plans, drawings or photographs, or written historic references as to its physical appearance.
Illustrated Dictionary of Architecture Copyright © 2012, 2002, 1998 by The McGraw-Hill Companies, Inc. All rights reserved

documentation

[‚däk·yə·mən′tā·shən]
(computer science)
The collection, organized and stored, of records that describe the purpose, use, structure, details, and operational requirements of a program, for the purpose of making this information easily accessible to the user.
McGraw-Hill Dictionary of Scientific & Technical Terms, 6E, Copyright © 2003 by The McGraw-Hill Companies, Inc.

documentation

(programming)
The multiple kilograms of macerated, pounded, steamed, bleached, and pressed trees that accompany most modern software or hardware products (see also tree-killer). Hackers seldom read paper documentation and (too) often resist writing it; they prefer theirs to be terse and on-line. A common comment on this predilection is "You can't grep dead trees".

See drool-proof paper, verbiage, treeware.
This article is provided by FOLDOC - Free Online Dictionary of Computing (foldoc.org)

documentation

The narrative and graphical description of a system. Following are the kinds of documentation required to describe an information system for both users and systems staff. See self-documenting code, technical writer and RTFM.

Operating Procedures



1. Instructions for turning the system on and getting the programs initiated (loaded).

2. Instructions for obtaining source documents for data entry.

3. Instructions for entering data at the terminal, which includes a picture of each screen layout the user will encounter.

4. A description of error messages that can occur and the alternative methods for handling them.

5. A description of the defaults taken in the programs and the instructions for changing them.

6. Instructions for distributing the computer's output, which includes sample pages for each type of report.

System Documentation



1. Data dictionary - Description of the files and databases.

2. System flow chart - Description of the data as it flows from source document to report.

3. Application program documentation - Description of the inputs, processing and outputs for each data entry, query, update and report program in the system.

Technical Documentation



1. File structures and access methods

2. Program flow charts

3. Program source code listings

4. Machine procedures (JCL)
Copyright © 1981-2019 by The Computer Language Company Inc. All Rights reserved. THIS DEFINITION IS FOR PERSONAL USE ONLY. All other reproduction is strictly prohibited without permission from the publisher.
Mentioned in ?
References in periodicals archive ?
The Documentation Usability Team will likely begin to shift its focus from ushering writers into the process of documentation testing to providing a constant flow of usability information on the MathWorks documentation.
Incorporating usability testing into the documentation process
Baseline data were obtained before staff education on the new documentation standards.
Standardizing Documentation: A Place for Everything
We realize that today's ambulatory practices have unique clinical workflows, and these once forced physicians to choose between documentation methods, losing time and efficiency in the process, said Peter Mahoney, senior vice president and general manager, Dragon and clinical documentation, Nuance.
NUANCE UNVEILS CLINICAL DOCUMENTATION SOLUTION
To do so, leaders have to understand the depth of documentation data that is needed to perform the detailed level of coding required.
Looking in the ICD-10 rearview mirror: did you take the right path?
* At the Winter Park, Fla.-based Adventist Health System, where 18 of 26 hospitals have so far gone live on CPOE, Kshitij Saxena, M.D., medical director, medical informatics, reports that he and his colleagues have actually gone live with physician documentation many months before CPOE.
Balancing act can CMIOs and CIOs make physician documentation work for everyone?
BluePrint uses the CAD data to automatically create unlimited views, details, and charts of the PCB, and can revise the documentation to reflect new PCB changes, reportedly in seconds.
Automating the documentation process: dedicated tools help reduce the once-manual job by 20% of the typical design cycle time
Appropriate documentation must be in place to support such intercompany transactions in a timely manner.
IRS takes aim at service issues in transfer pricing: two important legal pronouncements that will affect transfer pricing compliance and planning for multinational corporations have come out recently. Two attorneys discuss some of the general highlights and the potential impact
In our example, Company A in its proposal highlighted the benefits of its documentation module.
Creating customer value propositions
CM helps maintain consistency between the products and all relevant documentation. The CM process also documents and limits variances in a given product.
The adventures of CM Man
* Auditors should assemble audit documentation within 60 days from the audit report date.
Advancing the audit documentation standard: auditors must leave a clear record in private company audits
This nonprofessional documentary about journalists presupposes the very distance that guarantees the freedom of documentation as artistic praxis.
"After The News"; centre de cultura contemporania de barcelona

Encyclopedia browser ?
Full browser ?