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 ]

Documentation - Twitter Search

Great documentation! High dedication :)RT @donnykurniawan: THIS IS IT! http://myloc.me/1kBSB
Yulistias (Yulistias Yenny Hadi) Wed, 04 Nov 2009 11:07:22 -0000
Great documentation! High dedication :)RT @donnykurniawan: THIS IS IT! http://myloc.me/1kBSB
MTProfileServices (ブロックタグ) http://www.movabletype.jp/documentation/appendices/tags/profileservice.html
MT_Tags (MT_Tags) Wed, 04 Nov 2009 11:00:02 -0000
MTProfileServices (ブロックタグ) http://www.movabletype.jp/documentation/appendices/tags/profileservice.html
Do we need so much project documentation?: I think the PMO in my company is following the PMI guidelines: ea.. http://bit.ly/3YGcDb
AboutProjects (ASKABOUTPROJECTS) Wed, 04 Nov 2009 10:59:30 -0000
Do we need so much project documentation?: I think the PMO in my company is following the PMI guidelines: ea.. http://bit.ly/3YGcDb
Epydoc http://bit.ly/z8zAF python documentation programming tools development generator software tool epydoc
delicious50 (Delicious Over 50) Wed, 04 Nov 2009 10:59:21 -0000
Epydoc http://bit.ly/z8zAF python documentation programming tools development generator software tool epydoc
ArtigoSobre: Artigos com informações baseadas no GNU Free Documentation License contendo diversos assuntos http://bit.ly/4BBhn4
sitiopt (sitiopt) Wed, 04 Nov 2009 10:54:07 -0000
ArtigoSobre: Artigos com informações baseadas no GNU Free Documentation License contendo diversos assuntos http://bit.ly/4BBhn4
#MooTools Documentation for the #iphone: http://bit.ly/3gnD4e (via @mootoolified). - $2.99 for a documentation, WTF?!?
lionelrudaz (Lionel Rudaz) Wed, 04 Nov 2009 10:49:27 -0000
#MooTools Documentation for the #iphone: http://bit.ly/3gnD4e (via @mootoolified). - $2.99 for a documentation, WTF?!?

Subscribe to Documentation RSS feed