Difference between revisions of "Software documentation"
From Wiki @ Karl Jones dot com
Karl Jones (Talk | contribs) |
Karl Jones (Talk | contribs) (→See also) |
||
| Line 26: | Line 26: | ||
* [[Software]] | * [[Software]] | ||
* [[Software development]] | * [[Software development]] | ||
| + | * [[Software development process]] | ||
== External links == | == External links == | ||
* [https://en.wikipedia.org/wiki/Software_documentation Software documentation] @ Wikipedia | * [https://en.wikipedia.org/wiki/Software_documentation Software documentation] @ Wikipedia | ||
Revision as of 03:53, 9 September 2015
Software documentation (or simply documentation, or docs) is written text that accompanies computer software.
Description
Software documentation either explains how it 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:
- Requirements
- Statements that identify attributes, capabilities, characteristics, or qualities of a system.
- This is the foundation for what shall 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 source code, algorithms, interfaces, and APIs.
- End user
- Manuals for the end-user, system administrators and support staff.
- Marketing
- How to market the product and analysis of the market demand.
See also
External links
- Software documentation @ Wikipedia
