This article needs additional citations for verification. Please help improve this article by adding citations to reliable sources. Unsourced material may be challenged and removed. Find sources: "Software documentation" – news · newspapers · books · scholar · JSTOR(March 2013) (Learn how and when to remove this message)
Part of a series on
Software development
Core activities
Data modeling
Processes
Requirements
Design
Construction
Engineering
Testing
Debugging
Deployment
Maintenance
Paradigms and models
Agile
Cleanroom
Incremental
Prototyping
Spiral
V model
Waterfall
Methodologies and frameworks
ASD
DevOps
DAD
DSDM
FDD
IID
Kanban
Lean SD
LeSS
MDD
MSF
PSP
RAD
RUP
SAFe
Scrum
SEMAT
TDD
TSP
OpenUP
UP
XP
Supporting disciplines
Configuration management
Documentation
Software quality assurance
Project management
User experience
Practices
ATDD
BDD
CCO
CI
CD
DDD
PP
SBE
Stand-up
TDD
Tools
Compiler
Debugger
Profiler
GUI designer
UML Modeling
IDE
Build automation
Release automation
Infrastructure as code
Standards and bodies of knowledge
CMMI
IEEE standards
ISO 9001
ISO/IEC standards
PMBOK
SWEBOK
ITIL
IREB
OMG
Glossaries
Artificial intelligence
Computer science
Electrical and electronics engineering
Outlines
Outline of software development
v
t
e
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:
Requirements – 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 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.
and 26 Related for: Software documentation information
Softwaredocumentation is written text or illustration that accompanies computer software or is embedded in the source code. The documentation either explains...
Paper or hard-copy documentation has become less common.[citation needed] Documentation is often distributed via websites, software products, and other...
The GNU Free Documentation License (GNU FDL or simply GFDL) is a copyleft license for free documentation, designed by the Free Software Foundation (FSF)...
29119-3:2013. IEEE 829-2008, also known as the 829 Standard for Software and System Test Documentation, was an IEEE standard that specified the form of a set of...
environment (IDE), version control, computer-aided software engineering, and softwaredocumentation. Each of the available methodologies are best suited...
Software is a collection of programs and data that tell a computer how to perform specific tasks. Software often includes associated software documentation...
Software Development the practitioners value: Individuals and interactions over processes and tools Working software over comprehensive documentation...
Console System, DOCS (software) package Docs.com Colloquial term for Dr. Martens footwear. Google Docs Softwaredocumentation DOC (disambiguation) Dock...
A man page (short for manual page) is a form of softwaredocumentation usually found on a Unix or Unix-like operating system. Topics covered include computer...
Evolution of API Documentation". Fundamental Approaches to Software Engineering. International Conference on Fundamental Approaches to Software Engineering...
and software). It "consists of a number of separate programs, configuration files, which are used to set up these programs, system documentation, which...
messaging, and also used elsewhere in online forums, collaborative software, documentation pages, and readme files. The initial description of Markdown contained...
A documentation generator is a programming tool that generates softwaredocumentation intended for programmers (API documentation) or end users (end-user...
A software requirements specification (SRS) is a description of a software system to be developed. It is modeled after the business requirements specification...
Debian project decided to explicitly apply the same principles to softwaredocumentation, multimedia data and other content. The non-program content of Debian...
architecture description to support documentation of high-level and detailed design and construction of software. [IEEE 1016, Introduction] Following...
behavior, software interface, and rationale documentation. Accompanying the book is a wiki that contains an example of software architecture documentation. Bell...
reviewing code and associated documentation. Software testing is often used to answer the question: Does the software do what it is supposed to do and...
rarely-changing, informative content, such as product pages, news articles, softwaredocumentation, and blogs. SSGs typically consist of a template written in HTML...
(stylized as tldr-pages) is a free and open-source collaborative softwaredocumentation project that aims to be a simpler, more approachable complement...
are found in commercial softwaredocumentation from 2014 and 2023. While a deprecated software feature remains in the software, its use may raise warning...
documentation is produced, published or formatted. For example, the Diátaxis framework (which is mostly used in the field of softwaredocumentation )...
is easily found in the documentation, user guide, owner's manual, man page, online help, internet forum, softwaredocumentation or FAQ. Usage is variously...
Microsoft Learn is a library of technical documentation and training for end users, developers, and IT professionals who work with Microsoft products...
Global Information