Skip to main content

Manual de Introdução: Ferramenta de Investigação e Detecção de Inconsistências Hidrológicas

Introdução​

Este manual serve como uma introdução à ferramenta, explicando seu propósito principal, como ela funciona em um nível conceitual e onde encontrar informações mais detalhadas, tanto para usuários quanto para desenvolvedores.

As informações podem ser acessadas pela barra de navegação que possui três pastas: Manual de Usuário, Manual de Desenvolvimento e Manual de implantação.

Barra de navegação

2. Manual de usuário: onde encontrar informações sobre o uso da ferramenta.​

Este manual documenta todas as seções da ferramenta, servindo como um guia completo para orientar os usuários sobre suas funcionalidades e procedimentos de operação. Pode ser acessado na primeira pasta no menu de navegação ou pelo link: Manual de Usuário

As páginas estão divididas em:

  1. Página Inicial: O que encontrar?: Explica em detalhes o processo de login, incluindo os diferentes tipos de usuário com permissão para acessar a ferramenta.
  2. Fluxograma Operacional: Disponibiliza um resumo visual das operações que um usuário pode executar no sistema, facilitando a compreensão do fluxo de trabalho.
  3. Fluxo de Login: Essa página explica como é feito o Login e quais usuários podem acessar a ferramenta.
  4. Como selecionar uma estação: Nessa página são apresentados os recursos de seleção e busca de estações, para serem realizadas adequações ou supervisões posteriormente.
  5. Gráficos das estações: o que representam e onde encontrar: Este guia detalha os diferentes gráficos disponíveis para cada estação, explicando como interpretá-los e onde localizá-los para análise de dados.
  6. Adequações: Como fazer?: Esta seção instrui o usuário sobre como realizar adequações ou correções de dados no sistema, detalhando os procedimentos necessários para garantir a qualidade e a precisão das informações.
  7. Manual de Supervisão: Um guia para os usuários com perfil de supervisão. Mostra os recursos do supervisor na ferramenta.
  8. Manual de Administração: Um guia para os usuários com perfil de Administrador. Mostra os recursos do administração na ferramenta.

3. Manual de desenvolvimento: onde encontrar informações técnicas.​

Este manual documenta a arquitetura e os componentes técnicos do projeto, servindo como um guia essencial para desenvolvedores. As seções a seguir detalham cada parte do sistema. Pode ser acessado na segunda pasta no menu de navegação ou pelo link: Manual de Desenvolvimento. As pastas com os manuais específicos estão divididas em:

  1. Backend: Inclui documentação sobre a API, o Backend-API e a extração de dados da ANA, que utiliza o extrator.
  2. Banco de Dados: Disponibiliza os diagramas de entidade-relacionamento (DER) e o dicionário de dados da aplicação. Essencial para compreender a estrutura, as tabelas e os relacionamentos do banco de dados.
  3. FrontEnd: Contém a documentação da arquitetura do frontend, incluindo a estrutura de componentes, o gerenciamento de estado e a integração com o servidor Bokeh para a visualização de dados.
  4. Keycloak: Detalha os requisitos e o passo a passo para configurar uma instância local do Keycloak, permitindo que o desenvolvedor replique o ambiente de autenticação e autorização do projeto.
  5. Métodos estatísticos: Breve resumo sobre os métodos estatísticos utilizados no projeto.

4. Manual de Impantação: onde encontrar informações de implantação.​

O manual de implantação detalha a infraestrutura utilizada, os serviços envolvidos e os passos necessários para configurar e verificar o ambiente. Esse manual pode ser encontrado na terceira pasta ou pelo link: Manual de Implantação.