Technical documentation


Technical documentation consists of that set of documents and materials that can provide support and knowledge in certain areas.

Documentation in the context of wikitesto

Especially in the field of computer science, it includes useful material for understanding the features and functionality of a given system, tool or procedure. Usually widespread in electronic or paper format, it is divided into several categories: guides, manuals, howto, FAQs, etc. Each of them has different purposes and features, for example the specificity of the subject, its structure and the level of depth. For example, HowTo is specifically addressed to resolve a specific issue, while guides are usually of a broader scope.

Documentation has become increasingly important in the computer world, developing the need for new professional figures capable of providing the right union of in-depth knowledge of the described subject and adequate expressive capabilities. Although the documentation is often written by the same developer or system designer, the number of documentaries is growing, professionals dedicated exclusively to system documentation.

In addition to user documentation, there are more technical documentation specifically targeted at software developers. They can describe, for example, the APIs, Data Structures, and algorithms of a given component. Directories included in source code from programmers are also documentation. In this regard, software has been developed to extract and automatically generate well-structured and exportable documentation in various formats. Voices correlateemodify wikitesto

wiki