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

Watching a documentation about the Vandals, an East Germanic(no!not former inhabitants of the GDR)tribe of the 5th century on German TV #ntv
Physiater (Andreas Ulrich) Sun, 13 Dec 2009 02:30:08 -0000
Watching a documentation about the Vandals, an East Germanic(no!not former inhabitants of the GDR)tribe of the 5th century on German TV #ntv
Turns out it wasn't a bug. I mis-interpreted the wildstartech.com documentation. I need xalan 2.7.1 *and* the enableThreading==false.
edburns (edburns) Sun, 13 Dec 2009 02:12:30 -0000
Turns out it wasn't a bug. I mis-interpreted the wildstartech.com documentation. I need xalan 2.7.1 *and* the enableThreading==false.
I didn't fail at making documentation, I suceeded at staying & worshipping Him with all my heart.
peanutsrock (Rinni Astuti W.) Sun, 13 Dec 2009 02:05:49 -0000
I didn't fail at making documentation, I suceeded at staying & worshipping Him with all my heart.
Eh division documentation and publication siesta - hands up dooong. Graphic imaginary kapan dikerjain? We're running outta time
blameitonangga (angga the anggora) Sun, 13 Dec 2009 02:04:47 -0000
Eh division documentation and publication siesta - hands up dooong. Graphic imaginary kapan dikerjain? We're running outta time
@jaredrichardson actually, *definitely*!! @marisaseal and I found a lack of documentation, so blogs and documentation for Selenesse upcoming
dckismet (Dawn Cannan) Sun, 13 Dec 2009 02:03:53 -0000
@jaredrichardson actually, *definitely*!! @marisaseal and I found a lack of documentation, so blogs and documentation for Selenesse upcoming
MTPageCustomFields (ブロックタグ・MT4.1以降) http://www.movabletype.jp/documentation/appendices/tags/pagecustomfields.html
MT_Tags (MT_Tags) Sun, 13 Dec 2009 02:00:02 -0000
MTPageCustomFields (ブロックタグ・MT4.1以降) http://www.movabletype.jp/documentation/appendices/tags/pagecustomfields.html

 
Subscribe to Documentation RSS feed

directory of related sites

404 history - General introductory information about what was 'Acorn Computers' and their operating system, RISC OS which is now being developed by RISC OS Ltd. [by Richard Atterer]

404 !Boot and Module Database - Paul Vigay's page about the new !Boot structure, and Modules.
Meta Description: [ www.vigay.com : Search ]

Acorn Documentation - Assorted documentation for 32-bit and 8-bit machines, including Customer Services Application Notes and back issues from Acorn User magazine's Customer Hotline column.

Acorn Quiz - Test your knowledge of the platform here.
Meta Description: [ Domain name renewal and affordable web hosting packages from Network Solutions ]

Acorn/RISC OS machines - Untechnical history of Acorn machines, and an up to date look at where RISC OS machines are today.

ANT Support - Application notes - Details the URL broadcast mechanism, DNS resolver, SWI interface, MIME encoding of files, mapping between file types, and the plug-in protocol. Includes source code to example programs, list of registered URLs, compatible applications, filetypes and icons.

ARM Assembler Programming - A series of articles on assembler programming on the ARM, by Richard Murray.
Meta Description: [ Contains information on learning to program ARM assembler; while mainly concentating on the assembler built into BBC BASIC, there is coverage for APCS; common code is described with examples, utilities, applications, relocatable modules, and so on. ]

Blastzone's RISC OS Tutorial - The 3-button mouse, desktop, task manager, filer and applications are covered as well as a glossary.
Meta Description: [ RISC OS information and links. Bush Internet TV. Useful RISC OS applications. Creating Adobe PDF documents under RISC OS, Information about Acorn's RISC Operating System ]

Ccdoc - Tool that generates HTML documentations from C/C++ header files.

comp.sys.acorn FAQ List - Frequently Asked Questions (with answers) of the comp.sys.acorn.* newsgroups.

E-Format Map explanation and FAQ - The details of the E disc format, in a form that isn't overly technical, by Sergio Monesi.

Over-clocking the StrongARM SA-110 - Instructions on how to exceed 300 MHz.
Meta Description: [ Ian Hawkins website and geek blog with anime related stuff thrown in too ]

Stuart Tyrrell Developments: Parallel Ports - Document outlining how to access the parallel port on various Acorn machines.

USENET FAQs - General Acorn and RISC OS information, games FAQ, networking FAQ, and Acorn FTP and mail server archives information.

Documentation related videos
Announcements: NatGeo, Docs, Nov 21 GIG!!!
Next Video
Documentation related videos

 

HOMEADVERTISINGABOUT US

articlesartsbusinesscomputersgameshealthhospitalshomekids & teensnewsmobilephysiciansrecreationreferenceregionalscienceshoppingsocietysportsworld


Submit a Site About Become an Editor