Software documentation: Difference between revisions

Revision as of 20:18, 10 February 2025

Revision as of 01:55, 14 March 2025

Line 1:

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

{{more citations needed|date=March 2013}}

'''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.

{{Software development process}}

'''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.

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

* [[Requirement]]sRequirements – 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]]sAPIs.

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

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