العربية
中国
Français
Deutsch
Ελληνική
हिन्दी
Italiano
日本語
Português
Русский
EspañolDOCUMENTATION
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.
Common types of computer hardware/software documentation include online help, FAQs, HowTos, and user guide s. The term RTFM is often used in regard to such documentation, especially to computer hardware and software user guides.
A common type of software document frequently written by software engineers in the simulation industry is the SDF (software documentation folder). While developing the software for a simulator, which can range from embedded avionics devices to 3D terrain databases to full motion control systems, the engineer keeps a notebook detailing the development lifecycle of the project. The notebook can contain a requirements section, an interface section detailing the communication interface of the software, a notes section to detail the proof of concept attempts to track what worked or didn't work in solving certain problems, and a testing section to detail how the software will be tested to prove conformance to the requirements of the contract. The end result is a detailed description of how the software is designed, how to build and install the software on the target device, and any known weaknesses in the design of the software. This document will allow future developers and maintainers of the trainer to come up to speed on the software design in as short a time as possible and have a documented reference when modifying code or searching for bugs.
In some European countries, 'documentation' in an academic context is an obsolete term for the field of study that is now known as library science or information science.
★ Court orders
★ Document
★ Freedom of information
★ Historical document
★ Template
★ Documentation Definition by The Linux Information Project (LINFO)
★ Information & Documentation List of selected tools
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.
Common types of computer hardware/software documentation include online help, FAQs, HowTos, and user guide s. The term RTFM is often used in regard to such documentation, especially to computer hardware and software user guides.
A common type of software document frequently written by software engineers in the simulation industry is the SDF (software documentation folder). While developing the software for a simulator, which can range from embedded avionics devices to 3D terrain databases to full motion control systems, the engineer keeps a notebook detailing the development lifecycle of the project. The notebook can contain a requirements section, an interface section detailing the communication interface of the software, a notes section to detail the proof of concept attempts to track what worked or didn't work in solving certain problems, and a testing section to detail how the software will be tested to prove conformance to the requirements of the contract. The end result is a detailed description of how the software is designed, how to build and install the software on the target device, and any known weaknesses in the design of the software. This document will allow future developers and maintainers of the trainer to come up to speed on the software design in as short a time as possible and have a documented reference when modifying code or searching for bugs.
In some European countries, 'documentation' in an academic context is an obsolete term for the field of study that is now known as library science or information science.
| Contents |
| See also |
| External Links |
See also
★ Court orders
★ Document
★ Freedom of information
★ Historical document
★ Template
External Links
★ Documentation Definition by The Linux Information Project (LINFO)
★ Information & Documentation List of selected tools
This article provided by Wikipedia. To edit the contents of this article, click here for original source.
psst.. try this: add to faves
Featured Companies
| Green Parrot Beach Houses Resort |
Documentation Companies
Below is the list of travel companies in Documentation we have in our travel directory
- Travel Agents (1)
