submit urlsubmit rss feedadd directory

article

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 ]


directory of related categories

 
Documentation RSS feed
Documentation - Twitter Search

MTApp:SettingGroup (ブロックタグ) http://www.movabletype.jp/documentation/appendices/tags/app:settinggroup.html
MT_Tags (MT_Tags) Mon, 28 Dec 2009 10:00:01 -0000
MTApp:SettingGroup (ブロックタグ) http://www.movabletype.jp/documentation/appendices/tags/app:settinggroup.html
Expert in EDF procedures and documentation http://post.ly/GPyV #jobs #international #development #humanitarian #aid
jobsintdev (jobsintdev) Mon, 28 Dec 2009 09:55:25 -0000
Expert in EDF procedures and documentation http://post.ly/GPyV #jobs #international #development #humanitarian #aid
Event handling and picking — Matplotlib v0.99.1.1 documentation: http://bit.ly/4RihkS
ppalme (ppalme Cont.Learning) Mon, 28 Dec 2009 09:39:09 -0000
Event handling and picking — Matplotlib v0.99.1.1 documentation: http://bit.ly/4RihkS
@tuomas_nieminen: The problem with sequence diagrams as fixed documentation is that they're either too abstract to contain anything useful
rytmis (Lauri Kotilainen) Mon, 28 Dec 2009 09:38:34 -0000
@tuomas_nieminen: The problem with sequence diagrams as fixed documentation is that they're either too abstract to contain anything useful
Shipping/Documentation Clerk (MYR1,000.00 - 1,500.00) - PROMINENT FREIGHT SERVICES SDN BHD - Petaling Jaya: Req.. http://bit.ly/4weYxe
apajob (Apa Job) Mon, 28 Dec 2009 09:38:09 -0000
Shipping/Documentation Clerk (MYR1,000.00 - 1,500.00) - PROMINENT FREIGHT SERVICES SDN BHD - Petaling Jaya: Req.. http://bit.ly/4weYxe
http://linkbee.com/EVOZQ Generate DITA Java API reference documentation using DITADoclet and DITA API specialization
legendf2 (Legend Dream) Mon, 28 Dec 2009 09:32:05 -0000
http://linkbee.com/EVOZQ Generate DITA Java<trade></trade> API reference documentation using DITADoclet and DITA API specialization

 
Subscribe to Documentation RSS feed

directory of related sites

Acorn Object Format v2 - Historical document defining a file format called ARM Object Format, which is used by language processors for ARM-based systems.

Acorn Object Library Format v1 - Historical document defining a file format called ARM Object Library Format, which is used by language processors for ARM-based systems.

Acorn Technical Documents Archive - Technical documents, including many early ones. A hardware bias, includes links to hardware projects.

Documentation related videos
Building the A380 - Giant of the Skies Part 3
Next Video
Documentation related videos

 

HOMEADVERTISINGABOUT US

articlesartsbusinesscomputersgameshealthhospitalshomekids & teensnewsmobilephysiciansrecreationreferenceregionalscienceshoppingsocietysportsworld


Submit a Site About Become an Editor