Qual é a diferença entre documentação e referência de api?

Em geral, este é o problema se termos. Documentação é um termo genérico e costuma ser usado para falar sobre qualquer tipo de ... bem ... documentação. Ou seja, a Referência da API pode ser considerada como um tipo de documentação. Sem dúvida, usar esses dois termos juntos pode ser confuso para os visitantes, pois pessoas diferentes entenderão isso de maneira diferente.

Mas vamos tentar desenhar uma linha de qualquer maneira:

A Referência da API pode ser considerada diferente da Documentação em termos do tipo de informação que ela fornece. É uma referência - lista muito estruturada de métodos / funções / código de erro com descrições. Bastante técnico, bastante focado na API, direcionado aos desenvolvedores para servir como uma referência rápida ao escrever seu código nessa API.

Ou seja, você pode esperar não ver exemplos de implementação, conselhos práticos, práticas recomendadas, amostras para download. Frequentemente, a Referência da API é gerada automaticamente a partir da definição da API, comentários do código-fonte ou módulos compilados prontos (usando o .NET Reflection, por exemplo).

Isso nem sempre é verdade e cada referência de API é diferente. Mas essa é a diferença na maioria das vezes - a Referência da API é apenas uma referência de métodos, enquanto a Documentação pode fornecer mais exemplos, conhecimento técnico adicional, código de exemplo, conselhos de implementação. Às vezes, os desenvolvedores da API tentam mesclar essas partes específicas da documentação na Referência da API para fornecer as informações de uma forma mais sólida. E eles ainda a chamarão de Referência da API de qualquer maneira.

Para fazer uma distinção melhor, alguns autores técnicos usam o termo Documentação do usuário ou Guia do usuário em vez de apenas Documentação. Espero que isto faça sentido!