About

Software documentation is written text that accompanies computer software. It either explains how it operates or how to use it, and may mean different things to people in different roles.

The types of documentations are:

  1. Requirements: Statements that identify attributes, capabilities, characteristics, or qualities of a system. This is the foundation for what shall be or has been implemented.
  2. Architecture/Design: overview of software. It includes relations to an environment and construction principles to be used in design of software components.
  3. Technical: documentation of code, algorithms, interfaces, and APIs.
  4. End User: manuals for the end-user, system administrators and support staff.
  5. Marketing: how to market the product and analysis of the market demand.

Documenting source code can be helpful for anyone who might be reusing that piece of code. Many IDEs support *doc comments, such as Javadoc and PHPdoc.

history | show excerpt | excerpt history