Software documentation: Difference between revisions

Revision as of 20:16, 10 September 2020

Revision as of 20:16, 10 September 2020

Line 1:

{{short description|Explains the functionality of software}}

{{Deletar deletar Deletar thadeletar deletar deletar deletar deletar deletar]] .

{{refimprove|date=March 2013}}

Deletar deletar]] [[deletar deletar deletar deletar deletar deletar ]]types a [[Deletar deletar]]s.

'''Software documentation''' is written text or illustration that accompanies [[computer software]] or is embedded in the source code. The documentation either explains how the software operates or how to use it, and may mean different things to people in different roles.

* [[deletar deletar deletar deletar deletar

[[Documentation]] is an important part of [[software engineering]]. Types of documentation include:

* [[Requirement]]s – Statements that identify attributes, capabilities, characteristics, or qualities of a system. This is the foundation for what will be or has been implemented.

* Architecture/Design – Overview of software. Includes relations to an environment and construction principles to be used in design of software components.

* Technical – Documentation of code, algorithms, interfaces, and [[API documentation|API]]s.

* [[End user]] – Manuals for the end-user, system administrators and support staff.

* Marketing – How to market the product and analysis of the market demand.

== Requirements documentation ==