AgroMart: Avaliação da Qualidade do Software
Informações Gerais da Avaliação
| Item | Resposta |
|---|---|
| Nome do produto | AgroMart |
| Versão do produto | (v0.1 – sem versionamento oficial) |
| Domínio da aplicação do produto | Agricultura urbana, comércio justo |
| Objetivo da avaliação | Avaliar a compreensibilidade do código-fonte e da documentação |
Estabelecer os requisitos de avaliação
- Subcaracterística avaliada: Compreensibilidade
- Critério de qualidade: Manutenabilidade
- Foco: Código web e documentação
1. Propósito da Avaliação
O objetivo da avaliação é verificar a compreensibilidade do sistema AgroMart, com ênfase tanto na estrutura do código web quanto na documentação e na qualidade do código.
- Tem uma base de código clara, legível, coesa e bem estruturada;
- Tenha documentação acessível e atualizada para facilitar a compreensão e situar novos desenvolvedores;
- Possua boas práticas de modularização, comentários, e testes que suportem a evolução contínua do sistema;
- Possibilite que vários desenvolvedores, com diferentes níveis de experiência, possam contribuir ou modificar o sistema com segurança.
O AgroMart é um software que possui código aberto e colaborativo, que pode receber manutenção por diferentes desenvolvedores ao longo do tempo. Logo, a clareza, organização e documentação são de extrema importância para garantir a longevidade e reusabilidade.
2. Identificação do Tipo de Produto
Produtos avaliados: Interface Web + Documentação Técnica
| Aspecto | Descrição |
|---|---|
| Tipo | Aplicação Web (React/TypeScript) + Repositório de Documentação (docs) |
| Usuários-alvo | Desenvolvedores atuais e futuros colaboradores do AgroMart |
| Finalidade | Permitir fácil entendimento, modificação e extensão do sistema |
| Tecnologias Utilizadas | React, TypeScript, HTML, CSS, Markdown, GitHub Pages |
| Repositórios Avaliados | agromart-web e docs |
| Ambientes Esperados | Ambientes de desenvolvimento modernos (Node.js, navegadores atualizados) |
2.1. Critérios de Qualidade e Ênfase
A tabela abaixo detalha os critérios de qualidade considerados e o nível de ênfase atribuído a cada um (em uma escala de 0 a 5, onde 0 é o menor e 5 é o maior):
| Critério de Qualidade | Ênfase (0 a 5) |
|---|---|
| Funcionalidade | 2 |
| Confiabilidade | 3 |
| Usabilidade | 3 |
| Portabilidade | 1 |
| Eficiência | 2 |
| Completude | 3 |
| Manutenabilidade | 5 |
2.2. Componentes a Serem Avaliados
Para esta avaliação, os componentes centrais da interface web do AgroMart que serão analisados são:
- Código-fonte: Organização dos componentes, uso de boas práticas e estrutura do projeto;
- Arquivos React e TypeScript: Nomenclatura, modularidade, separação de responsabilidades;
- Testes automatizados: Presença, cobertura e clareza dos testes;
- Documentação interna: Comentários e arquivos de apoio à compreensão do sistema.
2.3. Modelo e Metodologia de Avaliação
ISO/IEC 25010 — Subcaracterística: Compreensibilidade
A compreensibilidade está relacionada à capacidade dos desenvolvedores de entenderem a estrutura, o comportamento e as responsabilidades do sistema de forma rápida e precisa. Isso inclui:
- Organização e nomeação dos arquivos e componentes;
- Uso de comentários explicativos e boas práticas de código;
- Presença de documentação técnica, READMEs, diagramas e fluxos;
- Coerência entre o que está documentado e o que está implementado.
Q-RAPID — Visão Estratégica
No modelo Q-RAPID, a compreensibilidade está associada a:
- Redução da curva de aprendizado para novos desenvolvedores;
- Minimização de erros por má interpretação;
- Facilidade na colaboração em equipe e transferência de conhecimento;
- Sustentabilidade do código a longo prazo, mesmo com mudanças na equipe.
Avaliação da Manutenabilidade
A avaliação da manutenabilidade do AgroMart permitirá:
- Identificar pontos fracos na organização do código;
- Medir a qualidade dos testes existentes e sua cobertura;
- Avaliar se o sistema é compreensível e facilmente extensível por novos desenvolvedores.
3. Conexões com os Objetivos de Desenvolvimento Sustentável (ODS)
O grupo identificou o AgroMart como tendo alinhamento com os seguintes ODS:
- ODS 1 (Erradicação da Pobreza) e ODS 8 (Trabalho decente e crescimento Econômico): Promover o desenvolvimento econômico local e reduzir as desigualdades, proporcionando aos agricultores familiares uma plataforma para comercializar seus produtos diretamente aos consumidores.
- ODS 2 (Fome Zero e Agricultura Sustentável): Contribuir para a segurança alimentar, reduzindo o desperdício de alimentos e promovendo práticas agrícolas sustentáveis.
- ODS 10 (Redução das Desigualdades): Fomentar a autonomia dos produtores e fortalecer a agricultura familiar, reduzindo as desigualdades no acesso ao mercado.
- ODS 12 (Consumo e Produção Responsáveis): Promover o consumo consciente e a produção responsável, conectando consumidores a co-agricultores e incentivando práticas sustentáveis.
4. Questões de Análise do Projeto
| Questão | Resposta |
|---|---|
| Q1: Quais são os principais usuários do produto? | Agricultores CSA e consumidores finais. |
| Q2: Quais são as principais tarefas do produto? | Cadastro de produtos, compra, gestão de loja, visualização em mapa. |
| Q3: Quais funções merecem maior dedicação durante a avaliação? | Componentes com alta complexidade e rotas principais da aplicação. |
| Q4: Quantas janelas de interação o sistema possui? | Oito interfaces principais com rotas distintas. |
| Q5: Qual o ambiente de execução do produto? | Navegadores modernos com frontend em React/TypeScript e backend no Firebase. |
| Q6: Qual o nível de conhecimento exigido dos desenvolvedores? | Médio a avançado em frontend moderno; básico em Git e Markdown. |
| Q7: Quais são os principais componentes a serem avaliados? | Estrutura de código (agromart-web) e documentação de apoio (docs). |
| Q8: Existe massa de dados disponível para a avaliação? | Não. A avaliação será feita por inspeção de código e análise da documentação existente. |
| Q9: Quais são os requisitos de desenvolvimento? | Node.js, npm/yarn, VSCode, navegador e ambiente Linux ou Windows. |
| Q10: Quais tecnologias o projeto utiliza? | React, TypeScript, Firebase, TailwindCSS, GitHub Pages, Markdown. |
Requisitos de Software (ambiente de desenvolvimento)
| Item | Recomendado |
|---|---|
| Sistema Operacional | Windows 10+, Ubuntu 20.04+, macOS 11+ |
| Node.js | v16.x ou superior |
| npm ou yarn | npm v8+ / yarn v1.22+ |
| Navegador moderno | Google Chrome, Firefox, Edge (últimas versões) |
| Editor de código | VSCode (com extensões para React, ESLint, Prettier) |
ℹ️ As dependências estão no
package.json. O projeto usa React com TypeScript e TailwindCSS.
Requisitos de Hardware (mínimos para desenvolvimento)
| Item | Especificação mínima |
|---|---|
| CPU | Dual-core (Intel i3, Ryzen 3) |
| RAM | 4 GB (mínimo), 8 GB recomendados |
| Armazenamento | SSD com pelo menos 500 MB livres |
| Rede | Conexão com acesso ao GitHub, Firebase e Node registry |