incremento do product view, sprints e organização dos arquivos

gitpage/docs/backlog.md

@@ -22,19 +22,77 @@ Uma user story é uma descrição curta e simples do que um usuário deseja real
 
 > **"Como [tipo de usuário], quero [ação/funcionalidade], para que [benefício/valor esperado]."**
 
-### **Exemplo de User Story (Derivada do Épico acima)**
+---
+
+# Critérios de aceitação
+
+## **Como definir critérios de aceitação?**
+
+**Clareza e especificidade**: Os critérios devem ser objetivos e fáceis de entender.  
+**Orientados ao comportamento**: Devem descrever o que o sistema deve fazer, não como deve ser implementado.  
+**Testáveis**: Devem permitir a validação por meio de testes claros e repetíveis.
+
+## Estrutura comum para critérios de aceitação
+
+Critérios de aceitação geralmente são escritos no formato Dado... Quando... Então, que segue a lógica:
+
+- **Dado**: o contexto inicial ou condição prévia.
+- **Quando**: o evento ou ação realizada pelo usuário.
+- **Então**: o resultado esperado ou comportamento do sistema.
+
+---
+
+## Épicos e User Story e seus Critérios de Aceitação
+
+### Critérios de Aceitação para as Histórias de Usuário  
+
+---
+
+#### **História 1: Visualização Gráfica dos Dados**  
+
+**"Como cliente, eu quero visualizar os dados de uma forma mais amigável e correta, para definir melhor a minha opinião sobre determinado dado."**  
+
+Critérios de Aceitação:  
+
+1. **Dado** que o cliente acesse a página de visualização de dados, **quando** os dados forem carregados, **então** eles devem ser exibidos em gráficos interativos e claros (ex.: gráficos de barras, linhas, ou pizza).  
+2. **Dado** que o cliente interaja com o gráfico, **quando** ele passar o mouse sobre um ponto ou barra, **então** deve aparecer uma descrição detalhada (ex.: valores exatos e datas).  
+3. **Dado** que os dados exibidos sejam grandes ou complexos, **quando** o cliente quiser ver mais detalhes, **então** deve haver uma opção de zoom ou foco em um período específico.  
+
+---
+
+#### **História 2: Filtragem dos Dados**
+
+**"Como cidadão, eu quero filtrar os dados sobre os quais eu tenho interesse e sem distrações, para facilitar o acesso aos meus interesses."**  
+
+Critérios de Aceitação:  
+
+1. **Dado** que o cidadão esteja na interface de visualização de dados, **quando** ele selecionar um filtro (ex.: ano, categoria, município), **então** os dados exibidos devem ser atualizados de acordo com os critérios escolhidos.  
+2. **Dado** que o cidadão queira aplicar múltiplos filtros, **quando** ele escolher mais de um critério, **então** os dados devem refletir a interseção das condições.  
+3. **Dado** que nenhum filtro seja selecionado, **quando** o cidadão acessar a página, **então** os dados devem ser exibidos de forma geral e sem filtros aplicados.  
+4. **Dado** que o filtro aplicado não retorne resultados, **quando** o cidadão finalizar a seleção, **então** uma mensagem amigável deve informar que "não há dados correspondentes".  
+
+---
+
+#### **História 3: Comparação de Dados**
+
+**"Como usuário, eu quero a possibilidade de comparar os dados de diferentes datas, para que seja possível uma análise de eficiência governamental durante os anos."**  
+
+Critérios de Aceitação:  
+
+1. **Dado** que o usuário esteja na interface de comparação, **quando** ele selecionar duas ou mais datas ou períodos, **então** os dados correspondentes devem ser exibidos lado a lado ou sobrepostos no mesmo gráfico.  
+2. **Dado** que os dados de diferentes períodos sejam exibidos, **quando** o usuário clicar em uma linha ou barra do gráfico, **então** informações detalhadas (ex.: valor exato e data) devem ser mostradas para cada período selecionado.  
+3. **Dado** que o usuário deseje alterar os períodos comparados, **quando** ele ajustar a seleção, **então** os gráficos devem ser atualizados automaticamente.  
+4. **Dado** que os períodos selecionados não possuam dados, **quando** o usuário concluir a seleção, **então** uma mensagem deve informar que "não há dados disponíveis para as datas escolhidas".  
+
+---
 
-**"Consulta de Editais de Licitação"**  
+#### **História 4: Exportação de Dados**
 
-- **Como** empresário,  
-- **quero** acessar e baixar os editais de licitação do município,  
-- **para que** eu possa participar dos processos de contratação pública de forma informada.  
+**"Como cidadão interessado, quero exportar os dados sobre o município em formato CSV, para realizar análises detalhadas e cruzar informações com outras bases de dados."**  
 
-## Épicos e User Story
+Critérios de Aceitação:  
 
-| **Épico**                    | **História de Usuário**                                                                                                          | **Prioridade**        |
-|------------------------------|--------------------------------------------------------------------------------------------------------------------------|-----------------------|
-| **Visualização Gráfica dos Dados**  | Como cliente, eu quero visualizar os dados de uma forma mais amigável e correta. Para definir melhor a minha opinião sobre determinado dado.                     | - |
-| **Filtragem dos Dados**  | Como  cidadão, eu quero filtrar os dados sobre os quais eu tenho interresse e sem distrações. Para facilitar o acesso aos meus interresses.          | - |
-| **Comparação de Dados**  | Como usuário, eu quero a possibilidade da comparação dos dados de difentes datas. Para que seja possível uma análise de eficiência governamental durante os anos. | - |
-| **Exportação de Dados** | Como cidadão interressado, quero exportar os dados sobre o município em formato CSV. Para realizar análises detalhadas e cruzar informações com outras bases de dados. | - |
+1. **Dado** que o cidadão esteja visualizando os dados filtrados, **quando** ele clicar no botão de exportação, **então** um arquivo no formato CSV contendo os dados visíveis deve ser baixado.
+2. **Dado** que o arquivo CSV seja gerado, **quando** o cidadão abrir o arquivo, **então** os dados devem estar organizados em colunas com cabeçalhos claros e consistentes.  
+3. **Dado** que o cidadão não tenha selecionado filtros, **quando** ele clicar no botão de exportação, **então** o CSV deve conter todos os dados disponíveis.  
+4. **Dado** que ocorra algum erro na exportação, **quando** o cidadão tentar realizar o download, **então** uma mensagem de erro deve ser exibida com instruções para tentar novamente.  

gitpage/docs/config.md

@@ -1,10 +1,15 @@
 ## Configuração de ambiente
+
 - Python 3.12
+
 * Clone o repositório deste projeto através da seguinte linha de código
+
 ```bash
 git clone https://github.com/unb-mds/2024-2-Squad14.git
 ```
+
 ### Bibliotecas
+
 - Streamlit
 - Numpy
 - Matplotlib
@@ -14,7 +19,9 @@ pip install streamlit
 pip install numpy
 pip install matplotlib
 ```
+
 ### Executando o programa
+
 ```bash
 streamlit run gov_app.py
-```
+```

gitpage/docs/index.md

@@ -64,4 +64,4 @@
     <a href="https://github.com/ribmarcos">ribmarcos</a>
 </div>
 
-</div>
+</div>

gitpage/docs/productview.md

@@ -0,0 +1,33 @@
+# Visão do Produto
+
+## Objetivo
+
+Criar um painel de transparência municipal acessível e intuitivo que permita aos cidadãos monitorar e entender facilmente como os recursos públicos estão sendo utilizados, promovendo a participação cidadã e a confiança na administração pública.
+
+## Público-Alvo
+
+Todos os cidadãos do município, incluindo:
+
+- **Residentes**
+- **Jornalistas**
+- **Pesquisadores**
+- **Autoridades públicas**  
+
+Com ênfase em ser acessível a usuários com diferentes níveis de habilidades tecnológicas.
+
+## Diferenciação
+
+- Oferecer uma **interface amigável**.
+- Integrar informações municipais de forma transparente e compreensível.
+- Utilizar **visualizações de dados atraentes e interativas** para facilitar a compreensão e a análise.
+
+## Benefícios Principais
+
+- **Acesso Rápido e Fácil**  
+  Os cidadãos poderão acessar informações sobre despesas, receitas e projetos em andamento de forma clara e detalhada.
+
+- **Transparência e Confiança**  
+  Aumentará a transparência governamental e fortalecerá a confiança da população na administração pública.
+
+- **Engajamento Cidadão**  
+  Facilitará a participação ativa dos cidadãos nos assuntos municipais.

gitpage/docs/sprints.md

@@ -0,0 +1,59 @@
+# Planejamento do Projeto
+
+## Sprint 0: Preparação Inicial
+
+- **Definição do grupo**  
+  Identificar os membros da equipe e estabelecer o comprometimento de todos.  
+- **Verificação de funções específicas de cada membro do grupo**  
+  Delegação de responsabilidades e papéis com base nas habilidades individuais.  
+
+---
+
+## Sprint 1: Estudos e Organização  
+
+### **Estudos dos seguintes tópicos e abertura de issues associadas**  
+
+- **Artefatos, Rituais, Papéis** – *Responsável: Marcos*  
+- **Planning Poker** – *Responsável: Marco*  
+- **História de Usuário** – *Responsável: Eduardo*  
+- **Critérios de Aceitação** – *Responsável: Arthur*  
+- **Burndown** – *Responsável: Luiz*  
+- **Dívida Técnica** – *Responsável: André*  
+
+### **Ações Adicionais**  
+
+- Criação de templates para documentações – *Responsável: José*  
+
+---
+
+## Sprint 2: Definição do Escopo  
+
+- **Montagem do escopo do produto**  
+  Utilizar a ferramenta *Mural* para realizar uma *Lean Inception* e consolidar as principais funcionalidades e requisitos.  
+
+---
+
+## Sprint 3: Definição da Arquitetura  
+
+- **Planejamento técnico inicial**  
+   Escolha das tecnologias a serem utilizadas.  
+   Rascunho da arquitetura do software.  
+   Elaboração de pseudocódigos iniciais para guiar o desenvolvimento.  
+
+---
+
+## Sprint 4: Implementação e Revisão  
+
+- **Aplicação prática dos estudos**  
+   Desenvolvimento de códigos oficiais com base nos tópicos estudados.  
+- **Revisão técnica**  
+   Verificação do funcionamento correto de APIs e *web scraping*.  
+
+---
+
+## Sprint 5: Preparação para a Release 1  
+
+- **Avaliação do produto**  
+   Alinhar expectativas e tarefas com toda a equipe presente.  
+- **Planejamento da entrega**  
+   Organizar os detalhes finais para a primeira *release*.  

gitpage/mkdocs.yml

@@ -64,7 +64,10 @@ theme:
 nav: 
   - Home: index.md
   - Sprints: sprints.md
-  - Tecnologias: tecnology.md
-  - Backlog: backlog.md
-  - Requisitos: requisitos.md
-  - Configuração/Execução: config.md
+  - Documentação de Projeto:
+    - Visão de Produto: productview.md
+    - Tecnologias: tecnology.md
+    - Backlog: backlog.md
+    - Requisitos: requisitos.md
+    - Arquitetura: arquitetura.md
+  - Configuração/Execução: config.md

gitpage/site/index.html

@@ -528,43 +528,43 @@ <h2 id="colaboradores">Colaboradores</h2>
 <div style="display: flex; flex-wrap: wrap; gap: 20px; justify-content: center;">
 
 <div style="text-align: center;">
-    <img src="../colaboradores/eduardo_img.jpg" alt="EduardoWaski" class="img-redonda">
+    <img src="colaboradores/eduardo_img.jpg" alt="EduardoWaski" class="img-redonda">
     <br>
     <a href="https://github.com/EduardoWaski">EduardoWaski</a>
 </div>
 
 <div style="text-align: center;">
-    <img src="../colaboradores/jose_img.jpg" alt="RR2M4A" class="img-redonda">
+    <img src="colaboradores/jose_img.jpg" alt="RR2M4A" class="img-redonda">
     <br>
     <a href="https://github.com/RR2M4A">RR2M4A</a>
 </div>
 
 <div style="text-align: center;">
-    <img src="../colaboradores/marco_img.png" alt="marcomarquesdc" class="img-redonda">
+    <img src="colaboradores/marco_img.png" alt="marcomarquesdc" class="img-redonda">
     <br>
     <a href="https://github.com/marcomarquesdc">marcomarquesdc</a>
 </div>
 
 <div style="text-align: center;">
-    <img src="../colaboradores/andre_img.png" alt="AndreMeyerr" class="img-redonda">
+    <img src="colaboradores/andre_img.png" alt="AndreMeyerr" class="img-redonda">
     <br>
     <a href="https://github.com/AndreMeyerr">AndreMeyerr</a>
 </div>
 
 <div style="text-align: center;">
-    <img src="../colaboradores/luis_img.jpg" alt="lfelipebessa" class="img-redonda">
+    <img src="colaboradores/luis_img.jpg" alt="lfelipebessa" class="img-redonda">
     <br>
     <a href="https://github.com/lfelipebessa">lfelipebessa</a>
 </div>
 
 <div style="text-align: center;">
-    <img src="../colaboradores/artur_img.jpg" alt="ArturDCR" class="img-redonda">
+    <img src="colaboradores/artur_img.jpg" alt="ArturDCR" class="img-redonda">
     <br>
     <a href="https://github.com/ArturDCR">ArturDCR</a>
 </div>
 
 <div style="text-align: center;">
-    <img src="../colaboradores/marcos_img.png" alt="ribmarcos" class="img-redonda">
+    <img src="colaboradores/marcos_img.png" alt="ribmarcos" class="img-redonda">
     <br>
     <a href="https://github.com/ribmarcos">ribmarcos</a>
 </div>