Documentation

Definition

Documentation refers to written materials that provide information about how to use or understand a software application, system, or code. It includes user manuals, technical guides, API references, and code comments.

Related terms

Commenting: Commenting is the practice of adding explanatory notes within source code to help other developers understand its functionality.

Readme File: A readme file is a document placed in project folders that provides essential information about the project's purpose, installation instructions, usage guidelines, etc.

API Documentation: API documentation describes how developers can interact with an application's programming interfaces (APIs) by providing details about available endpoints, parameters, response formats, etc.