In general terms, documentation is any communicable material (such as text, video, audio, etc., or combinations thereof) used to explain some attributes of an object, system or procedure. It is often used to mean engineering or software documentation, which is usually paper books or computer readable files (such as HTML pages) that describe the structure and components, or on the other hand, operation, of a system/product.

A professional whose field and work is more or less exclusively to write documentation is called a documenter. Normally, documenters are trained or have a background in technical writing, along with some knowledge of the subject(s) they are documenting. Often, though, some part or all of the documentation process is done by the engineers responsible for the system/product to be documented.

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

More on [ Documentation ]

Software Infrastructure - RSS Sponsorship

HP's first 13.3-inch Pavilion vs. the competition
Wed, 01 Oct 2008 12:34:18 -0700
HP is shipping its first laptop with a 13.3-inch widescreen display. The HP Pavilion dv3500t series is already available on HP's site starting at $1,000, and a slightly higher-end configuration, the dv3520nr, is available for pre-order at Best Buy for $1,200. Other sites have reported that this model will be...
HP's first 13.3-inch Pavilion vs. the competition
Wed, 01 Oct 2008 12:34:18 -0700
HP is shipping its first laptop with a 13.3-inch widescreen display. The HP Pavilion dv3500t series is already available on HP's site starting at $1,000, and a slightly higher-end configuration, the dv3520nr, is available for pre-order at Best Buy for $1,200. Other sites have reported that this model will be...
HP's first 13.3-inch Pavilion vs. the competition
Wed, 01 Oct 2008 12:34:18 -0700
HP is shipping its first laptop with a 13.3-inch widescreen display. The HP Pavilion dv3500t series is already available on HP's site starting at $1,000, and a slightly higher-end configuration, the dv3520nr, is available for pre-order at Best Buy for $1,200. Other sites have reported that this model will be...
A new mystery: What's Microsoft got up its Office Live sleeve?
Wed, 01 Oct 2008 12:22:06 -0700
It sounds like Microsoft has yet another Professional Developers Conference PDC announcement percolating -- beyond the Windows 7, Oslo, cloud OS (Red Dog/Zurich) and Mesh Platform stuff about which the company already has been dropping hints. by Mary Jo Foley
A new mystery: What's Microsoft got up its Office Live sleeve?
Wed, 01 Oct 2008 12:22:06 -0700
It sounds like Microsoft has yet another Professional Developers Conference PDC announcement percolating -- beyond the Windows 7, Oslo, cloud OS (Red Dog/Zurich) and Mesh Platform stuff about which the company already has been dropping hints. by Mary Jo Foley
A new mystery: What's Microsoft got up its Office Live sleeve?
Wed, 01 Oct 2008 12:22:06 -0700
It sounds like Microsoft has yet another Professional Developers Conference PDC announcement percolating -- beyond the Windows 7, Oslo, cloud OS (Red Dog/Zurich) and Mesh Platform stuff about which the company already has been dropping hints. by Mary Jo Foley

Subscribe to Operating_Systems RSS feed