Software documentation

Written or visual material that explains a software system’s purpose, design, operation, installation, or use. It helps people understand, operate, maintain, and change software.

User manual: A guide explaining how to operate a product or system. It focuses on helping end users complete tasks with the software.
Docs as code: A practice of writing and maintaining documentation with software-development tools and workflows. It brings documentation changes into version control and review.
Installation guide: Instructions for installing and configuring software in a target environment. It helps users move from obtaining software to a working setup.
Source code: Human-readable instructions and declarations that define or implement a computer program. Code specifies executable behavior; documentation explains that behavior and its context.
API documentation: Reference material describing a software interface, including its operations, inputs, outputs, and behavior. It tells developers how to interact with a software system programmatically.
Documentation generator: Software that produces documentation from source code, structured data, or marked-up text. It can keep reference pages synchronized with source interfaces.
Troubleshooting: The process of diagnosing and resolving problems in a system. Support documentation often maps symptoms to diagnostic steps and fixes.
Technical writing: Writing that communicates technical information clearly to a defined audience. Software documentation is a specialized form of technical writing.
README: A project’s introductory file, usually explaining its purpose, setup, and basic use. It often provides the first orientation to a software repository.
Static site generator: A tool that builds a website from source files into static HTML and related assets. It commonly turns documentation files into browsable websites.

Linked from 3 pages