Análise da Avaliação – GQM e PSM

Abordagem GQM (Goal - Question - Metric)

O método GQM visa estruturar a avaliação de qualidade com base em três níveis: Objetivo, Questões e Métricas. A seguir, apresentamos a aplicação dessa abordagem na avaliação da API AgroMart.

Objetivo

Avaliar a usabilidade da API AgroMart do ponto de vista de desenvolvedores com diferentes níveis de experiência, com foco na efetividade da documentação e retorno das mensagens da API.

Questões

A documentação está clara o suficiente para que o usuário compreenda o propósito e use a API com autonomia?
Os endpoints estão organizados de maneira lógica e acessível?
As mensagens de erro são compreensíveis e úteis para a resolução de problemas?
O tempo para executar uma requisição simples é aceitável?
O retorno dos dados da API é padronizado e de fácil leitura?

Métricas

As seguintes métricas foram derivadas diretamente das entrevistas:

1.1 Grau de compreensão do propósito da API
1.2 Nota de clareza da documentação (escala de 1 a 5)
1.3 Facilidade de navegação na documentação
1.4 Facilidade em encontrar endpoints
1.5 Tempo estimado para requisição simples
2.1 - 2.3 Clareza e utilidade das mensagens de erro
2.4 Padronização e estruturação das respostas da API
2.5 Classificação geral da experiência de integração

A aplicação da GQM permitiu evidenciar as principais fragilidades da API sob a ótica da usabilidade, com base em dados objetivos e respostas qualitativas.

Complemento com o Framework PSM (Practical Software Measurement)

O PSM busca transformar dados em decisões por meio da definição de medidas práticas e alinhadas a objetivos organizacionais. A avaliação da API AgroMart dialoga com as seguintes categorias do PSM:

Informação sobre Produto: Documentação

Medição Observada: Documentação avaliada como incompleta, pouco clara e de difícil navegação.
Indicador PSM: 0% de usuários que entenderam a documentação sem auxílio externo.
Resultado: 0% dos entrevistados afirmou ter compreendido totalmente o conteúdo.

Informação sobre Processo: Facilidade de Integração

Medição Observada: Tempo médio estimado para requisição simples varia entre 5 e 30 minutos.
Indicador PSM: Tempo médio de execução de tarefa básica.
Resultado: Indica deficiência de onboarding técnico e ausência de guias adequados.

Qualidade do Produto: Compreensão de Erros

Medição Observada: Baixa clareza nas mensagens de erro, com notas entre 1 e 4.
Indicador PSM: 0% de erros compreensíveis sem suporte externo.
Resultado: Apenas 1 participante afirmou se sentir confiante ao resolver problemas com base no retorno da API.

Conclusão da Análise

A combinação dos frameworks GQM e PSM possibilitou uma análise estruturada e orientada à melhoria contínua. Os dados coletados confirmam que a API AgroMart ainda não está pronta para uso externo sem frustração ou suporte adicional.

Recomendações com base na análise:

Reestruturar a documentação com foco em clareza e completude.
Criar exemplos práticos e guias de configuração (ex: arquivo .env, dependências).
Padronizar e melhorar as mensagens de erro da API.
Reduzir a curva de aprendizado por meio de tutoriais e fluxo inicial bem definido.

O uso dessas abordagens facilita a priorização de ações corretivas e o acompanhamento de progresso em futuras versões da API.

📑 Histórico de Versão

Versão	Data	Descrição	Autor
`1.0`	08/07/2025	Criação da página de análise da avaliação	Mayara Alves