atualização da documentação

docs/_sidebar.md

@@ -3,8 +3,8 @@
 **Visão Geral**
 
 - [Visão Geral do Produto](/visao_geral/visao_geral_produto.md)
-- [Arquitetura do Software](/concepcao/arquitetura_software.md)
-- [Dados Necessários](/concepcao/dados_necessarios.md)
+- [Arquitetura do Software](/visao_geral/arquitetura_software.md)
+- [Dados Necessários](/visao_geral/dados_necessarios.md)
 
 **Produto**
 

docs/equipe/reunioes/atas.md

@@ -1,7 +1,5 @@
 # Atas de reuniões
 
-## **Guia de Contribuição**
-
 As reuniões são fatores importantes para o seguimento e acompanhamento das Sprints, e podem ter diferentes objetivos, como: 
 - **Reunião com o Cliente:** essas reuniões visam, principalmente, o alinhamento de expectativas com o cliente, bem como os processos iniciais do projeto, como reuniões de onboarding e acompanhamento. 
 - **Reunião de Planejamento da Sprint (Planning):** conduzidas antes de cada Sprint, com tempo fixo de uma hora para cada semana de duração da Sprint. Essa reunião atende dois principais pontos: Definição do objetivo e Identificação e Estimativa de Tarefas. 
@@ -56,8 +54,12 @@ Sendo assim, para o Projeto do Querido Diário, as nossas reuniões seguem um pr
 
 <iframe width="560" height="315" src="https://www.youtube.com/watch?v=Iwk7SDnu6O4&list=PLzc7_ULvysmaWqXep2_gHKyNE7AExAZae&index=2" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
 
+## **Heatmap do time**
+
+<img src="./imagens/heatmap.png"/> 
+
 ## Histórico de Versão
 
 | Versão |    Data    |                 Descrição                 |        Responsáveis          |       Revisor        |
 | :----: | :--------: | :---------------------------------------: | :------------------------------------------------------------------------------------------: | :---------------------------------------------: |
-|  1.0   |            |                                           |                              |                      |
+|  1.0   | 25/03/2024  | Criação da documentação sobre Reuniões   | [Raissa Oliveira](https://github.com/raissamsoliveira)                           |    [Ester Lino](https://github.com/esteerlino)  

docs/equipe/sprints/sprints.md

@@ -1,7 +1,5 @@
 # Sprints
 
-## **Guia de Contribuição**
-
 Uma Sprint é uma iteração com um tempo fixo de 1 a 4 semanas de duração. Nesse período o SCRUM Master guia e facilita o Time de impedimentos internos e externos evitando distraçãões que poderiam afetar a meta da Sprint. Durante esse período, o time trabalha para converter os requisitos do Backlog Priorizado do Produto em funcionalidades que podem ser entregues. Sendo assim, ficou definido para o **Projeto do Querido Diário** o seguinte: 
 
 - Cada Sprint terá duração de 2 semanas - podendo ser ajustado posteriormente.
@@ -17,9 +15,11 @@ Uma Sprint é uma iteração com um tempo fixo de 1 a 4 semanas de duração. Ne
 
 ### Objetivos da sprint
 
+____________________________________________________________________________________________________________
+
 
-### Histórico de versão
+### Histórico de Versão
 
-| Data | Descrição | Autor(es) | Revisor(es) |
-|--------|---------|-----------|-------------|
-|        |         |           |             |
+| Versão |    Data    |                 Descrição                 |        Responsáveis          |       Revisor        |
+| :----: | :--------: | :---------------------------------------: | :------------------------------------------------------------------------------------------: | :---------------------------------------------: |
+|  1.0   | 25/03/2024  | Criação da documentação sobre Sprints | [Raissa Oliveira](https://github.com/raissamsoliveira)                           |    [Ester Lino](https://github.com/esteerlino) |

docs/visao_geral/arquitetura_software.md

@@ -0,0 +1,27 @@
+# **Arquitetura do Querido Diário**
+
+A arquitetura do **Querido Diário** é um reflexo das decisões técnicas que conectam duas pontas: o conjunto de soluções necessárias para enfrentar os obstáculos impostos pela disponibilização de diários oficiais e o interesse pela abertura destes dados. Assim, podemos resumir o fluxo do projeto para cada um dos tipos de diário oficial às etapas abaixo e compreendê-los mais detalhadamente a seguir: 
+
+- **Coletar:** obter arquivos de diários oficiais na fonte, os sites publicadores
+- **Processar:** aplicar tratamentos sobre os arquivos originais obtidos
+- **Disponibilizar:** permitir acesso e pesquisa nos conteúdos armazenados
+
+Sendo assim, o processo de extração de texto possui o seguinte fluxo: 
+
+1. Spiders coletam os arquivos e metadados, que são salvos no portgresql e o arquivo no Sistema de Arquivos. 
+2. Diariamente um job do data processing busca no postgresql quais os arquivos que ainda não foram processados - existe uma flag na base para isso.
+3. O job baixa o arquivo original.
+4. O job manda o arquvo original para o Apache Tika e obtem o texto puro.
+5. O job grava um arquivo txt no Sistema de Arquivos com o texto puro junto ao arquivo original.
+6. O job grava no index do motor de busca (opensearch) um novo registro contendo os metadados, o texto do documento e url de acesso tanto do arquivo original quanto do arquivo .txt.
+7. O job marca o registro do diario processado no postgresql como "feito".
+
+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**
+
+____________________________________________________________________________________________________________
+<img src="./imagens/fluxo_dados2.png"/>
+
+____________________________________________________________________________________________________________
+

docs/visao_geral/visao_geral_produto.md

@@ -1,7 +1,12 @@
 # **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.
+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.
 
-O Diário Oficial da União (DOU) e os Diários Oficiais dos Estados (DOE) são, frequentemente, objetos de interesse coletivo já consolidados, enquanto os Diários Oficiais Municipais (DOM), especialmente de cidades que não fazem parte de uma região metropolitana, são menos acompanhados. Não à toa. Apesar de públicos, esses documentos são disponibilizados por vias difíceis de serem acompanhadas.
+## **Declaração do Problema**
 
-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.
+Para este projeto foi proposto o desenvolvimento de rotinas de processamento de dados, criação de pontos de acesso na API e desenvolvimento de interfaces na plataforma web para atender as situações abaixo:
+
+|                           |                                                                      | 
+| ------------------------- | -------------------------------------------------------------------- |
+|   **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 |