Bem-vindo(a) à Documentação do Plugin SAA

Esta documentação serve como o repositório central de informações e conhecimento do Plugin SAA (Sistema de Abastecimento de Água), um projeto desenvolvido pela COBRAPE, focado em processamento geoespacial dentro do ambiente QGIS.

Neste momento inicial do projeto, a documentação está focada primariamente nos algoritmos de processamento que representam a parte principal da ferramenta. O objetivo é garantir que a base técnica seja sólida, clara e totalmente documentada antes da construção da interface final do Plugin no QGIS.

A estrutura foi desenhada para atender a diferentes perfis de público, desde o usuário final até o desenvolvedor que deseja se aprofundar no código ou contribuir.

Estrutura da Documentação

A documentação está dividida em três seções principais, cada uma com um foco específico:

Guia do Usuário

A seção Guia do Usuário funciona como um manual prático para a utilização das ferramentas SAA. Seu objetivo é guiar o usuário em todas as etapas de execução, desde a instalação até a análise de resultados. Nela, o usuário poderá aprender a usar as funcionalidades, consultar as etapas específicas de cada processamento e solucionar dúvidas sobre a operação.

Desenvolvimento

A seção de Desenvolvimento é o repositório técnico do projeto. Ela aborda em profundidade os assuntos específicos do trabalho de codificação e implementação dos algoritmos. É aqui que são documentadas as decisões estratégicas tomadas durante o projeto, os detalhes da modelagem de dados e todas as instruções técnicas necessárias para entender, manter e auditar o backend do SAA.

Contribuição

A seção de Contribuição é o ponto de partida para qualquer pessoa que deseje colaborar com o projeto. Ela é dedicada a abordar e padronizar as instruções de contribuição, desde a maneira correta de submeter novas funcionalidades até, principalmente, as diretrizes para a criação e revisão da documentação em si.