Teach Time Encyclopedia - Learn About Our World
Home Page
Teach Time
Featured Topics

United States
by state

CITYology

Academic Disciplines

Historical Timelines

Themed Timelines

Calendars

Reference Tables

Biographies

How-tos



Saturday, July 26, 2008

Documentation

In general terms, documentation is any communicable material (such as text, video, audio, etc., or combination thereof) used to explain some attributes of an object or system. It is often used to mean software documentation, which is usually paper books or readable computer files (such as HTML pages) that describe how to operate computer programs.

A person who writes documentation is a documenter. Normally, documenters are trained or have a background in technical writing, along with some knowledge of the subject they are documenting.

Documentation is often referred to as the "boring side" of engineering, or considered a necessary evil. This is largely unavoidable since most engineers prefer to build things instead of to document them, and being implicit experts in what they have built, they have little motivation in documenting their creations so that others may understand them.

The term RTFM is often used in regard to documentation.

Types of documentation include FAQ, HowTo, guide.



Internet Hotel Solutions

Site Sponsors
AC Units
Baltimore Harbor
Boot Camp Grads
Bra Size
Burkittsville
College Hotels
Digital Harbor
Free Cell Phones
Golden Hare Travel
Golf Vacations
Golf Courses
Gourmet
Hair Styles
Hippodrome
iWoman
Lesson Plans
Maryland Hotels
MD Genealogy
Minor League Stuff
Motel Site
Ocean City
OC Real Estate
Old Agers
Office Supplies
Orlando
Pet Friendly Hotel
Room Prices
Savannah, GA
Ski Vacations
South Baltimore
Student Teaching
Travel Sources
University Hotels
Visit Military Bases
Washington, DC

Brought to you by NoChildLeftBehind.com and the Beaches and Towns Network, LLC.