Definição de documentação

Quando falamos documentação/documentar, nós queremos dizer representar (normalmente em texto), uma descrição dos principais aspectos do produto ou serviço, permitindo consulta e validação das partes envolvidas.

Por quê documentar uma API?

  1. Auxiliar os usuários da API a entenderem seus recursos.

Mostrar, por exemplo, parâmetros utilizados, tipo de retorno de dados (JSON/XML).

  1. Abstrair detalhes da API.

O que é necessário trazer de essencial para o usuário que irá usufruir da aplicação.

  1. Servir de referência para o time.

Para sistemas grandes, para ter uma consulta, é bem necessário ter uma documentação robusta da aplicação para existir referências.

Atualizado