Merge pull request #23 from ResidenciaTICBrisa/cria-backlog-e-atualiz…

…a-documentacao

Refatora documentos de arquitetura e visão geral, adicionando documentos de backlog do produto e sprint 05.

docs/_sidebar.md

@@ -4,6 +4,9 @@
 
 - [Visão Geral do Produto](/visao_geral/visao_geral_produto.md)
 - [Arquitetura do Software](/visao_geral/arquitetura_software.md)
+- [Backlog do Produto](/visao_geral/backlog.md)
+- [Roadmap do Produto](/visao_geral/roadmap.md)
+
 <!--- [Dados Necessários](/visao_geral/dados_necessarios.md)-->
 
 
@@ -19,6 +22,8 @@
     - [Sprint 01](/equipe/sprints/sprint1.md)
     - [Sprint 02](/equipe/sprints/sprint2.md)
     - [Sprint 03](/equipe/sprints/sprint3.md)
+    - [Sprint 04](/equipe/sprints/sprint4.md)
+    - [Sprint 05](/equipe/sprints/sprint5.md)
 - [Reuniões](/equipe/reunioes/atas.md)
     - [Ata 01](/equipe/reunioes/ata1.md)
     - [Ata 02](/equipe/reunioes/ata2.md)

docs/equipe/sprints/sprint2.md

@@ -1,4 +1,4 @@
-# Sprint 2
+# Sprint 02
 
 - Data de início: 03/02/2024
 - Data de término: 09/02/2024

docs/equipe/sprints/sprint3.md

@@ -1,4 +1,4 @@
-# Sprint 3
+# Sprint 03
 
 - Data de início: 10/03/2024
 - Data de término: 16/03/2024

docs/equipe/sprints/sprint4.md

@@ -1,4 +1,4 @@
-# Sprint 4
+# Sprint 04
 
 - Data de início: 17/03/2024
 - Data de término: 23/03/2024

docs/equipe/sprints/sprint5.md

@@ -0,0 +1,19 @@
+# Sprint 05
+
+- Data de início: 23/03/2024
+- Data de término: 08/04/2024
+
+## Objetivos da sprint
+* Configuração do ambiente
+    * Alguns integrantes do time ainda estavam com problemas com o ambiente.
+* No dia 29/03 houve uma reunião com a Bruna para tentar resolver problemas com o ambiente do projeto e marcamos uma reunião com a ela na terça dia 02/04.
+* No dia 01/04 se deu início ao desenvolvimento das histórias US-1 e US-2 e foram divididas as tarefas em dois grupos, com três integrantes para cada US.
+* No dia 03/04 houve uma reunião com a professora Carla, para revisar o repositório de documentação do projeto. Após isso foram constatados alguns pontos de melhoria na documentação do projeto.
+
+
+
+## Histórico de versão
+
+| Versão |    Data    |   Descrição   |       Responsáveis        |                     Revisor                     |
+| :----: | :--------: | :-----------: | :-----------------------: | :---------------------------------------------: |
+|  1.0   | 04/04/2024 | Adicionando documento da Sprint 5   | [Pedro Cabeceira](https://github.com/pkbceira03) |  [Cristian Furtado](https://github.com/csafurtado) |

docs/visao_geral/arquitetura_software.md

@@ -18,7 +18,7 @@ Sendo assim, o processo de extração de texto possui o seguinte fluxo:
 
 Uma vez que os registros estão no OpenSearch, a API consegue buscar por eles. Assim, a API traduz a requisição que ele recebe em um query no Opensearch e retorna o resultado para o usuário. 
 
-### **Jornada do Dado**
+## **Jornada do Dado**
 
 O processo de deduzir a **Jornada do Dado** envolve entender e mapear como os dados se movem e são processados em um sistema ou aplicação, desde sua origem até seu destino final, o que geralmente envolve identificar todas as etapas pelas quais os dados passam, as transformações que sofrem e as interações com diferentes componentes do sistema ao longo do caminho.
 
@@ -27,11 +27,35 @@ Esta jornada pode incluir várias etapas, como coleta, processamento, armazename
 Sendo assim, a Jornada do Dado dentro do projeto do Querido Diário está representada na imagem abaixo: 
 ____________________________________________________________________________________________________________
 <img src="./imagens/fluxo_dados2.png"/>
+<h5 style="text-align: center; margin: 0 auto">Figura 1: Arquitetura do projeto Querido Diário</h5>
 
 ____________________________________________________________________________________________________________
 
+
+### **Jornada do Dado na funcionalidade F1**
+
+<p>A funcionalidade 1 trabalha a área do front-end, onde será necessário manipular dados que aparecem na página após o resultado de uma pesquisa, seja ela a página do Querido Diário Geral ou do Querido Diário Educação, transformando-os em arquivos .csv para download. A figura abaixo descreve melhor dentro da arquitetura geral do projeto a área de influência da funcionalidade.</p>
+<p>Para esta funcionalidade também foi criado um <a href="https://www.figma.com/file/PTRrSgLiz6DOlkYwA3Tt6Q/Prot%C3%B3tipo-para-a-p%C3%A1gina-%22Tecnologia-na-Educa%C3%A7%C3%A3o%22?type=design&node-id=0%3A1&mode=design&t=86esN6klke9ftwbL-1">protótipo no Figma</a> para a visualização da página, com participação do cliente.</p>
+
+
+<img src="./imagens/Fluxo-Us1-Us2.png"/>
+<h5 style="text-align: center; margin: 0 auto">Figura 2: Fluxo de dados da funcionalidade 1</h5>
+
+
+
+<!-- 
+
+### **Jornada do Dado na fucionalidade F2**
+
+inserir o fluxo de dados da funcionalidade F@
+
+-->
+
+
 ## Histórico de Versão
 
 | Versão |    Data    |                 Descrição                 |                                         Responsáveis                                         |                     Revisor                     |
 | :----: | :--------: | :---------------------------------------: | :------------------------------------------------------------------------------------------: | :---------------------------------------------: |
-|  1.0   | 25/03/2024 |      Criação da página "Arquitetura do Querido Diário"       |    [Raissa Oliveira](https://github.com/raissamsoliveira)            |    [Ester Lino](https://github.com/esteerlino)    |
+|  1.0   | 25/03/2024 |      Criação da página "Arquitetura do Querido Diário"       |    [Raissa Oliveira](https://github.com/raissamsoliveira)            |    [Ester Lino](https://github.com/esteerlino)    |
+|  1.1  | 04/04/2024 |  Adicionando o fluxo de dados da funcionalidade F1 e legenda das figuras  |    [Cristian Furtado](https://github.com/csafurtado) e [Pedro Cabeceira](https://github.com/pkbceira03)          |    [Wildemberg Sales](https://github.com/wildemberg-sales)   |
+|  1.2  | 05/04/2024 |  Adiciona informação e link sobre o protótipo do Figma da funcionalidade 1 |    [Cristian Furtado](https://github.com/csafurtado)          | [Raissa Oliveira](https://github.com/raissamsoliveira) |

docs/visao_geral/backlog.md

@@ -0,0 +1,22 @@
+# **Backlog do Produto**
+
+Este documento mostra as funcionalidades propostas no projeto, descrevendo-as de forma textual e em forma de tabela.
+
+## Tabela de Funcionalidades
+
+| Épico |    Funcionalidade    |                 História de Usuário                |
+| :---: | :--------: | :--------------------------------------- |
+|  **(E1)** Downloads  | **(F1)** Fazer download de excertos para arquivo .csv |      **(US-1)** *Eu, como usuário, gostaria de selecionar os excertos que aparecem a partir da minha busca para fazer o download no Portal Educação.*       |
+|  |  |      **(US-2)** *Eu, como jornalista, gostaria de selecionar os excertos que aparecem a partir da minha busca para fazer o download.*     |
+|  | **(F2)** Fazer download de arquivos .txt agregados |      **(US-3)** *Eu, como desenvolvedor, gostaria de ter um ponto de acesso na API para listagem de URLs de arquivos de diários agregados e compactados por data e localidade.*     |
+|  |  |      **(US-4)** *Eu, como usuário, gostaria de baixar arquivos agregados de um período (ano) por localização (cidade e estado).*    |
+|  |  |      **(US-5)** *Eu, como jornalista, gostaria de baixar arquivos agregados de um período (ano) por localização (cidade e estado) no Portal Educação.*    |
+
+
+
+## Histórico de Versão
+
+| Versão |    Data    |                 Descrição                 |                                         Responsáveis                                         |                     Revisor                     |
+| :----: | :--------: | :---------------------------------------: | :------------------------------------------------------------------------------------------: | :---------------------------------------------: |
+|  1.0   | 04/04/2024 |      Criação da página "Backlog do Produto"       |    [Cristian Furtado](https://github.com/csafurtado) e [Pedro Cabeceira](https://github.com/pkbceira03)     |    [Wildemberg Sales](https://github.com/wildemberg-sales)   |
+|  1.1   | 04/04/2024 |      Correção de US's do artefato       |    [Wildemberg Sales](https://github.com/wildemberg-sales)    |   [Cristian Furtado](https://github.com/csafurtado)   |

docs/visao_geral/roadmap.md

@@ -0,0 +1,19 @@
+# **Roadmap do Produto**
+
+Este documento mostra o Roadmap da equipe, que irá mostrar o planejamento das atividades da equipe ao longo dos seis meses do projeto.
+
+<div style="position: relative; width: 100%; height: 0; padding-top: 100.0000%;
+ padding-bottom: 0; box-shadow: 0 2px 8px 0 rgba(63,69,81,0.16); margin-top: 1.6em; margin-bottom: 0.9em; overflow: hidden;
+ border-radius: 8px; will-change: transform;">
+  <iframe loading="lazy" style="position: absolute; width: 100%; height: 100%; top: 0; left: 0; border: none; padding: 0;margin: 0;"
+    src="https:&#x2F;&#x2F;www.canva.com&#x2F;design&#x2F;DAGAoQhT_Qs&#x2F;UmMFq-OqhjoX8WYMA3vunw&#x2F;view?embed" allowfullscreen="allowfullscreen" allow="fullscreen">
+  </iframe>
+</div>
+<a href="https:&#x2F;&#x2F;www.canva.com&#x2F;design&#x2F;DAGAoQhT_Qs&#x2F;UmMFq-OqhjoX8WYMA3vunw&#x2F;view?utm_content=DAGAoQhT_Qs&amp;utm_campaign=designshare&amp;utm_medium=embeds&amp;utm_source=link" target="_blank" rel="noopener">Roadmap | Querido Diário</a> de Raissa Sousa
+
+
+## Histórico de Versão
+
+| Versão |    Data    |                 Descrição                 |                                         Responsáveis                                         |                     Revisor                     |
+| :----: | :--------: | :---------------------------------------: | :------------------------------------------------------------------------------------------: | :---------------------------------------------: |
+|  1.0   | 04/04/2024 |      Criação da página "Roadmap do Produto"       |    [Cristian Furtado](https://github.com/csafurtado)    |    [Ester Lino](https://github.com/esteerlino) e [Raissa Oliveira](https://github.com/raissamsoliveira)    |

docs/visao_geral/visao_geral_produto.md

@@ -1,6 +1,14 @@
 # **Visão Geral do Produto**
 
-O **diário oficial** é uma publicação feita pelas esferas da administração pública brasileira, seja federal, estadual ou municipal e dos poderes executivo, legislativo e judiciário, que serve para tornar oficial para a população as ações tomadas pelos poderes. Apesar de públicos, esses documentos são disponibilizados por vias difíceis de serem acompanhadas. O **Querido Diário** é o projeto que enfrenta esse deserto de dados, oferecendo uma ferramenta que amplia o acesso à informação sobre a administração pública brasileira em sua mais local instância - os municípios -, através da abertura e centralização de diários oficiais eletrônicos. Não é uma empreitada fácil, sobretudo por existirem 5570 municípios no país e grandes discrepâncias quanto à existência e maturidade na disponibilização online de seus dados e informações.
+## **Descrição do Produto**
+
+### **O que é um diário oficial?**
+
+O **diário oficial** é uma publicação feita pelas esferas da administração pública brasileira, seja federal, estadual ou municipal e dos poderes executivo, legislativo e judiciário, que serve para tornar oficial para a população as ações tomadas pelos poderes. Apesar de públicos, esses documentos são disponibilizados por vias difíceis de serem acompanhadas. 
+
+### **O que é o Querido Diário?**
+
+O **Querido Diário** é o projeto que enfrenta esse deserto de dados, oferecendo uma ferramenta que amplia o acesso à informação sobre a administração pública brasileira em sua mais local instância - os municípios -, através da abertura e centralização de diários oficiais eletrônicos. Não é uma empreitada fácil, sobretudo por existirem 5570 municípios no país e grandes discrepâncias quanto à existência e maturidade na disponibilização online de seus dados e informações.
 
 ## **Declaração do Problema**
 
@@ -11,8 +19,21 @@ Para este projeto foi proposto o desenvolvimento de rotinas de processamento de
 |   **Como Jornalista**     | Conseguir realizar o download dos resultados da busca realizada na plataforma web do Querido Diário para sistematizar o processo de apuração de reportagens |
 |  **Como Pesquisador(a)**  | Conseguir realizar o download dos textos completos dos diários oficiais, para realizar meus próprios recortes e processamentos de forma transversal |
 
+<br>
+<br>
+
+Desta declaração, foram especificados quatro principais dores e pontos de melhoria apontados para o projeto:
+
+| |
+| ---- |
+| 1. Funcionalidade de download de resultados de busca no [“Querido Diário”](https://queridodiario.ok.org.br/) e [“Querido Diário: Tecnologias na Educação”](https://queridodiario.ok.org.br/educacao) desenvolvida na interface da plataforma web; |
+| 2. Desenvolvimento de rotina de agregação e compactação de arquivos de diários (em seu formato textual) em recortes geográficos e cronológicos (unidade federativa, município, ano, mês e dia) para disponibilização em sistema de arquivos em nuvem para download; |
+| 3. Ponto de acesso na API do [Querido Diário](https://queridodiario.ok.org.br/api/docs) para listagem de URLs de arquivos de diários agregados e compactados disponíveis para download pelos recortes geográficos e cronológicos desejados; |
+| 4. Página na plataforma web do projeto para download de diários oficiais em formato agregado e compactado pelos recortes geográficos e cronológicos desejados. |
+
 ## Histórico de Versão
 
 | Versão |    Data    |                 Descrição                 |                                         Responsáveis                                         |                     Revisor                     |
 | :----: | :--------: | :---------------------------------------: | :------------------------------------------------------------------------------------------: | :---------------------------------------------: |
-|  1.0   | 25/03/2024 |     Criação da página sobre "Visão Geral do Produto"     |    [Raissa Oliveira](https://github.com/raissamsoliveira)            |    [Ester Lino](https://github.com/esteerlino)    |
+|  1.0   | 25/03/2024 |     Criação da página sobre "Visão Geral do Produto"     |    [Raissa Oliveira](https://github.com/raissamsoliveira)            |    [Ester Lino](https://github.com/esteerlino)    |
+|  1.1  | 04/04/2024 |     Adicionando tópicos do produto e colocamos as funcionalidades    | [Cristian Furtado](https://github.com/csafurtado) e [Pedro Cabeceira](https://github.com/pkbceira03) |    [Ester Lino](https://github.com/esteerlino) e [Raissa Oliveira](https://github.com/raissamsoliveira)   |