Open main menu
Home
Random
Recent changes
Special pages
Community portal
Preferences
About Wikipedia
Disclaimers
Incubator escapee wiki
Search
User menu
Talk
Dark mode
Contributions
Create account
Log in
Editing
Software documentation
(section)
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
{{Short description|Explains the functionality of software}} {{more citations needed|date=March 2013}} {{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]]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.
Edit summary
(Briefly describe your changes)
By publishing changes, you agree to the
Terms of Use
, and you irrevocably agree to release your contribution under the
CC BY-SA 4.0 License
and the
GFDL
. You agree that a hyperlink or URL is sufficient attribution under the Creative Commons license.
Cancel
Editing help
(opens in new window)