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

writing documentation and wishing the libertines had kept it together long enough to make a 3rd album
anu (anu) Wed, 04 Nov 2009 11:15:19 -0000
writing documentation and wishing the libertines had kept it together long enough to make a 3rd album
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

 
Subscribe to Documentation RSS feed

directory of related sites

Collection of Computer Science Bibliographies: HPF - Searchable bibliography of publications.
Meta Description: [ Bibliographies on Parallel Processing, part of the Collection of Computer Science Bibliographies ]

Designing and Building Parallel Programs - Chapter of an online book.

404 EPCC HPF - Lecture notes and code from a course in parallel programming using HPF.

Fortran 90 for the Fortran 77 Programmer - Chapter of a Fortan 90 tutorial with specific information about HPF.

High Performance Fortran Applications - Tutorials, algorithms, sample code, and research papers.

High Performance Fortran Benchmark - Documentation, code, and technical reports.

HPF and PSE Manual - Introduction, tutorial, optimization tips, and reference material.

HPF Tutorials - Introduction to HPF, lecture notes, and tips for porting Fortran 77 to HPF.

Liverpool HPF Courses - Online courses in writing HPF programs.

Documentation related videos
IIPC (2005) 03/16 Hadith: How many witnesses are required for document validity by Mohammad Shaikh
Next Video
Documentation related videos

 

HOMEADVERTISINGABOUT US

articlesartsbusinesscomputersgameshealthhospitalshomekids & teensnewsmobilephysiciansrecreationreferenceregionalscienceshoppingsocietysportsworld


Submit a Site About Become an Editor