atualização da documentação, com os guias de contribuição para reuniõ…

…es e sprints.
ResidenciaTICBrisa · Mar 25, 2024 · b8215ef · b8215ef
1 parent 02dae22
commit b8215ef
Show file tree

Hide file tree

Showing 8 changed files with 99 additions and 6 deletions.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -2,9 +2,9 @@
 
 **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)
+- [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)
 
 **Produto**
 

diff --git a/docs/equipe/reunioes/ata1.md b/docs/equipe/reunioes/ata1.md
@@ -35,7 +35,7 @@
 | --- | -------------------- | --------------- | 
 | 1   | Estudo de FastAPI      | Todos         |
 | 2   | Estudo das ferramentas | Todos         |
-| 3   | Participar do onboarding oferecido pelo cliente no dia 12/03 | Ester, Arthur e Wildemberg  |
+| 3   | Participar do onboarding oferecido pelo cliente no dia 12/03 | Ester, Raissa, Arthur e Wildemberg  |
 
 ### **7. Gravação**
 

diff --git a/docs/equipe/reunioes/ata2.md b/docs/equipe/reunioes/ata2.md
@@ -36,7 +36,7 @@
 | --- | -------------------- | --------------- | 
 | 1   | Estudo da Documentação      | Todos         |
 | 2   | Estudo das ferramentas | Todos         |
-| 3   | Aguardar o Giulio enviar os arquivos que prometeu na reunião |
+| 3   | Aguardar o Giulio enviar os arquivos que prometeu na reunião | Cliente |
 
 ### **7. Gravação**
 

diff --git a/docs/equipe/reunioes/atas.md b/docs/equipe/reunioes/atas.md
@@ -1 +1,63 @@
-# Atas de reuniões
+# 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. 
+- **Reuniões Diárias (Daily):** é uma reunião curta, com duração de 15 minutos, onde os membros se reúnem para relatar o progresso do projeto, respondendo a três principais perguntas: 
+    1. O que eu fiz ontem? 
+    2. O que eu vou fazer hoje? 
+    3. Quais impedimentos (se houver) estou enfrentando atualmente? 
+
+Sendo assim, para o Projeto do Querido Diário, as nossas reuniões seguem um processo definido por todo o time: 
+- As Reuniões com o Cliente acontecem de forma síncrona e assíncrona, sendo a primeira marcada com pelo menos uma semana de antecedência quando solicitado por alguma das partes. 
+- A Planning acontecem sempre antes da Sprint iniciar, com duração máxima de duas horas - para uma Sprint de 2 semanas. 
+- A Daily acontece diariamente, de forma assíncrona, através do Discord, sempre às 10h - utilizamos um bot nesse processo. 
+- Todas as reuniões são documentadas por meio de uma ata, que segue o modelo abaixo:
+
+--------------------------------------------------------------------------------------------------------------------------------
+### **Modelo da Ata de Reunião**
+
+### **1. Identificação**
+
+| Data       | Hora de início | Hora de Término | Local           | Redator(es)               | Projeto        |
+| ---------- | -------------- | --------------- | --------------- | --------------------- | -------------- |
+|            |                |                 |                 |                       |                |
+
+| Convocados                                | Presente | Área/Empresa | E-mail                                 |
+| ----------------------------------------- | -------- | ------------ | -------------------------------------- |
+| 1. Arthur Ferreira                        | ✅       | Discente     | E-mail: <[email protected]>      |
+| 2. Cristian Furtado                       | ✅       | Discente     | E-mail: <[email protected]>  |
+| 3. Ester Lino                             | ✅       | Discente     | E-mail: <[email protected]>         |
+| 4. Pedro Cabeceira                        | ✅       | Discente     | E-mail: <[email protected]>      |
+| 5. Raissa Oliveira                        | ✅       | Discente     | E-mail: <[email protected]> |
+| 6. Wildemberg Sales                       | ✅       | Discente     | E-mail: <[email protected]> |
+
+### **2. Pauta**
+
+| N°  | Descrição                                                        |
+| --- | ---------------------------------------------------------------- |
+| 1   |                                                                  |
+
+### **3. Pendências Anteriores**
+
+| N°  | Pendência                              |
+| --- | -------------------------------------- |
+| 1   |                                        |
+
+### **4. Compromissos**
+
+| N°  | Compromisso          | Responsável     |
+| --- | -------------------- | --------------- | 
+| 1   |                      |                 |
+
+### **7. Gravação**
+
+<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>
+
+## Histórico de Versão
+
+| Versão |    Data    |                 Descrição                 |        Responsáveis          |       Revisor        |
+| :----: | :--------: | :---------------------------------------: | :------------------------------------------------------------------------------------------: | :---------------------------------------------: |
+|  1.0   |            |                                           |                              |                      |
diff --git a/docs/equipe/sprints/sprints.md b/docs/equipe/sprints/sprints.md
@@ -1 +1,25 @@
 # 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.
+- O Backlog do Produto, bem como o Backlog do Produto estão disponíveis [aqui](https://github.com/ResidenciaTICBrisa/T2G4-Querido-Diario). 
+- As Sprints são documentadas e seguem o modelo abaixo.
+
+-------------------------------------------------------------------------------------------------------------------------------------------
+
+## **Sprint XX**
+
+- Data de início: 
+- Data de término: 
+
+### Objetivos da sprint
+
+
+### Histórico de versão
+
+| Data | Descrição | Autor(es) | Revisor(es) |
+|--------|---------|-----------|-------------|
+|        |         |           |             |
diff --git a/docs/visao_geral/arquitetura_software.md b/docs/visao_geral/arquitetura_software.md
diff --git a/docs/visao_geral/dados_necessarios.md b/docs/visao_geral/dados_necessarios.md
diff --git a/docs/visao_geral/visao_geral_produto.md b/docs/visao_geral/visao_geral_produto.md
@@ -0,0 +1,7 @@
+# **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 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.
+
+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.