|
In the main terms, documentation is any communicable lesson (like text, videos, audio, etc., or even even combinations thereof) utilized to teach you a bit of attributes of an object, technique or procedure. These are typically wont to mean engineering or software documentation, which is usually paper books or even computer readable files (such as HTML pages) that describe the structure & components, or even then again, operation, of the system/product.
The sales person whose field & operate is just about entirely to write documentation is known as the documenter. Usually, documenters come trained or even have a background inside technical writing, along with occasionally noesis of the subject(s) it is documenting. Typically, though, a few a share or even 100% of the documentation run is handle the engineers responsible the system/product to become documented.
By engineers, maybe among software engineers in particular, documentation is often known as a "boring side" of engineering, or even considered the necessary evil. This is largely ineluctable since virtually all engineers like building items to documenting the babies, & existence inexplicit experts around what it stand built, it might stand little motivation inside documenting their creations thus that others will know the babies.
Most common types of computer hardware/software documentation include online help, FAQs, HowTos, and user guides. A term RTFM is often utilized around regard to such documentation, especially to hardware & software package user guides.
|