Roteiro de Entrevista – Avaliação da Usabilidade da API (AgroMart)
1. Introdução
Esta entrevista faz parte de uma avaliação da qualidade da API do sistema AgroMart, com foco específico em sua usabilidade do ponto de vista de quem consome os serviços ou seja, desenvolvedores para criação de uma CSA. A iniciativa se justifica pela indisponibilidade do aplicativo mobile da plataforma, o que levou a equipe a reestruturar o escopo da análise, priorizando a API implementada via Strapi.
O objetivo central é identificar a clareza, facilidade de compreensão e a eficiência na interação com os principais endpoints da API, além da capacidade do sistema em fornecer feedback útil, especialmente em situações de erro.
As respostas serão usadas para propor melhorias na documentação e experiência de desenvolvedores.
2. Metodologia
A entrevista será semiestruturada e dividida em duas seções:
- Parte 1 – Documentação: Avalia o quanto a documentação é clara, suficiente e orientativa.
- Parte 2 – Respostas da API: Avalia o conteúdo retornado pela API e a clareza nas mensagens.
Cada métrica será avaliada com escalas numéricas (1 a 5) e respostas abertas. A entrevista deve durar cerca de 20 minutos.
Os dados serão analisados quantitativamente (notas médias) e qualitativamente (interpretação das justificativas).
3. Roteiro de Entrevista
Dados do Participante
Nome (opcional): ________
Nível de experiência com APIs REST:
( ) Nenhuma ( ) Básica ( ) Intermediária ( ) Avançada
Parte 1 – Avaliação da Documentação
1.1 Você entendeu facilmente o propósito geral da API?
( ) Sim ( ) Mais ou menos ( ) Não
Justifique sua resposta:
1.2 Em uma escala de 1 a 5, como você avalia a clareza geral da documentação?
Nota: ___ (1 = Muito ruim / 5 = Muito clara)
1.3 A estrutura da documentação (títulos, agrupamento, ordem dos endpoints) facilitou a navegação?
( ) Sim ( ) Parcialmente ( ) Não
O que ajudou ou atrapalhou?
1.4 Foi fácil encontrar o endpoint necessário para executar uma ação simples (ex: buscar produtos)?
( ) Sim ( ) Mais ou menos ( ) Não
Detalhe sua experiência:
1.5 Quanto tempo você estima que levaria para montar e testar uma requisição básica (ex: GET de produtos)?
Tempo estimado: ___ minutos
1.6 Que melhorias você sugeriria na documentação?
Parte 2 – Avaliação das Respostas da API
2.1 A API retorna mensagens de erro compreensíveis?
( ) Sim ( ) Parcialmente ( ) Não
Mostre um exemplo de erro e pergunte: o que você entendeu dessa mensagem?
2.2 Em uma escala de 1 a 5, como você avalia a clareza das mensagens de erro da API?
Nota: ___
2.3 Você se sentiria confiante em resolver o problema com base apenas na mensagem retornada?
( ) Sim ( ) Talvez ( ) Não
O que facilitaria?
2.4 O retorno dos endpoints que você consultou era padronizado, estruturado e fácil de ler?
( ) Sim ( ) Parcialmente ( ) Não
Detalhe o que achou:
2.5 De forma geral, como você classificaria a experiência de integração com essa API?
( ) Muito difícil ( ) Difícil ( ) Regular ( ) Fácil ( ) Muito fácil
Por quê?
4. Estratégia de Análise
As métricas serão analisadas da seguinte forma:
| Métrica | Tipo | Análise |
|---|---|---|
| Grau de compreensão da documentação | Quantitativa (nota) + Qualitativa (justificativa) | Cálculo da média e identificação de termos recorrentes (ex: “confuso”, “direto”) |
| Dificuldade para encontrar endpoints | Qualitativa | Frequência de menções de dificuldade + exemplos concretos relatados |
| Tempo estimado de requisição básica | Quantitativa | Média geral de tempo estimado |
| Clareza das mensagens de erro | Quantitativa + Qualitativa | Média da nota + análise dos comentários sobre clareza |
| Capacidade percebida de resolução de erros | Qualitativa | Proporção de respostas “Sim”, “Talvez”, “Não” + justificativas |
| Avaliação geral da usabilidade da API | Quantitativa | Média de notas + percepção final agregada |
Observações Finais
As entrevistas serão conduzidas presencialmente ou online, com registro em planilhas ou Google Forms. As respostas coletadas embasarão a proposição de melhorias na documentação e tratamento de erros da API AgroMart.
📑 Histórico de Versão
| Versão | Data | Descrição | Autor |
|---|---|---|---|
1.0 |
06/07/2025 | Criação da página do roteiro da entrevista | Mayara Alves |