Alan Freedman -- The Computer Language Company - Computer Desktop Encyclopedia
Computer Desktop Encyclopedia
Longest-Running Tech Reference on the Planet

A CDE Definition

You'll love The Computer Desktop Encyclopedia (CDE) for Tech Term of the Day (TTOD)

LOOK UP ANOTHER TERM


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)



Personal Use Only

Before/After Your Search Term
BeforeAfter
Document Objectsdocuterm
document processingDOCX file
document publishing softwareDOD
document retrievalDOD cyberspace glossary
document rootDOD intelligence glossary
document scannerDOD military terms
document sharingDOF
document sharing sitedog bone
document sourcedog-food
document viewerdogcow

Terms By Topic
Click any of the following categories for a list of fundamental terms.
Computer Words You Gotta KnowSystem design
Job categoriesUnix/Linux
Interesting stuffPersonal computers
InternetIndustrial Automation/Process Control
Communications & networkingAssociations/Standards organizations
HistoryDesktop publishing
Audio/VideoGraphics
MainframesSecurity
ProgrammingHealthcare IT
System design