Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentacao #93

Merged
merged 24 commits into from
Dec 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
4679354
:memo:(#49): documentação da sprint 07
VieiraLaris Oct 30, 2023
a3a797f
:memo:(#49): subindo documentação para o site
VieiraLaris Oct 30, 2023
e2cff10
:memo: subindo documentação de sprints para o mkdocs
VieiraLaris Oct 30, 2023
f0cd775
:memo: subindo documentação de sprints para o site
VieiraLaris Oct 30, 2023
0ef6e1d
:memo: arrumando nome de arquivos
VieiraLaris Oct 30, 2023
b779b05
:memo: subindo documentação correta para o site
VieiraLaris Oct 30, 2023
5c1c2c8
:memo: documentação da sprint 8
VieiraLaris Nov 7, 2023
1b1fcc7
:memo: incluindo documentação no mkdocs
VieiraLaris Nov 7, 2023
8122fed
:memo: subindo documentação da sprint 8 para o site
VieiraLaris Nov 7, 2023
c918c09
:memo:(#71): documentação do planejamento da sprint 09
VieiraLaris Nov 22, 2023
8bb6583
:memo:(#71): documentação dos resultados da sprint 09
VieiraLaris Nov 22, 2023
e435a3d
:memo:(#71): adicionando documentação da sprint 09 no mkdocs
VieiraLaris Nov 22, 2023
9b5c29a
💡 (#56) : Adicionando Planejamento da Sprint 10
matheusbmello Nov 26, 2023
70f583f
💡 (#72) : Documentação da Sprint 10
matheusbmello Nov 26, 2023
f36406f
💡 (#72) : Adicionando para o MkDocs
matheusbmello Nov 26, 2023
e1d4eae
:bulb: (#69) : adicao de configuracoes para o code climate
anabborges Nov 27, 2023
4cf564f
:bug: (#69) : Tentando arrumar erro para atualizar o code climate
anabborges Nov 27, 2023
0464d5a
:bug: (#69): tentando arrumar erro do code climate
anabborges Nov 27, 2023
8c00393
:fire: : excluindo testes para o codeclimate
anabborges Nov 27, 2023
891e594
💡 (#89) : Adicionando planejamento da Sprint 11
matheusbmello Dec 5, 2023
74aa104
💡 (#89) : Adicionando os resultados da sprint 11
matheusbmello Dec 5, 2023
c4b9f70
💡(#89): Adicionando no mkdocs
matheusbmello Dec 5, 2023
ccab538
💡 (#90) : Adicionando planejamento da Sprint 12
matheusbmello Dec 5, 2023
fcede00
Dados modificados
BiancaPatrocinio7 Dec 5, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
28 changes: 28 additions & 0 deletions docs/Sprints/Sprint 07/Planejamento.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Nessa sprint o foco foi extensivamente voltado para finalizar as exigências da Release 1 do projeto. Além de adequar a documentação do projeto, criando a Release Note, complementando o README, atualizando as escolhas tecnológicas, entre outros, também foi colocado como objetivo dessa Sprint continuar a implementação tanto do front-end como também a do Regex. Por último, também foi planejada a criação de uma apresentação de slides e da simulação do protótipo de alta fidelidade para complementar a apresentação da R1.

## Histórico de Versões

| Data | Versão | Descrição | Autor |
| :--------: | :----: | :-------------------: | :-------------: |
| 30/10/2023 | 0.1 | Abertura do documento | [Larissa de Jesus Vieira](https://github.com/VieiraLaris)|

## Tamanho da Sprint

**Início:** 23/10/2023

**Término:** 30/10/2023

**Duração:** 7 dias

## Objetivos

| Issue | Título | Responsáveis |
| :------------------------------------------------------: | :-------------------------------: | :-------------------------------------------------: |
| [#43](https://github.com/unb-mds/2023-2-Squad08/issues/43)| Adequação ao Recommended Community Standards | [Bruno Henrique](https://github.com/bdebatata) e [Vitor Feijó](https://github.com/vitorfleonardo) |
| [#44](https://github.com/unb-mds/2023-2-Squad08/issues/44)| Criar Slides da Apresentação | [Matheus Mello](https://github.com/matheusbmello) e [Cecilia Quaresma](https://github.com/cqcoding) |
| [#45](https://github.com/unb-mds/2023-2-Squad08/issues/45)| Criar simulação do protótipo no figma | [Ana Clara Borges](https://github.com/anabborges) |
| [#46](https://github.com/unb-mds/2023-2-Squad08/issues/46)| Alteração na documentação de escolhas tecnológicas | [Larissa Vieira](https://github.com/VieiraLaris) |
| [#47](https://github.com/unb-mds/2023-2-Squad08/issues/47)| Finalizar tela Home da aplicação web | [Larissa Vieira](https://github.com/VieiraLaris), [Ana Clara Borges](https://github.com/anabborges) e [Vitor Feijó](https://github.com/vitorfleonardo) |
| [#48](https://github.com/unb-mds/2023-2-Squad08/issues/48)| Release Note do projeto | [Bianca Patrocinio](https://github.com/BiancaPatrocinio7) |
| [#49](https://github.com/unb-mds/2023-2-Squad08/issues/49)| Documentação da Sprint | [Larissa Vieira](https://github.com/VieiraLaris) |
| [#50](https://github.com/unb-mds/2023-2-Squad08/issues/50)| Bug Regex | [Bruno Henrique](https://github.com/bdebatata) e [Bianca Patrocinio](https://github.com/BiancaPatrocinio7) |
26 changes: 26 additions & 0 deletions docs/Sprints/Sprint 07/Resultados.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Os resultados da sprint foram ótimos, foi possível perceber um bom desenvolvimento do front-end e do Regex, além da documentação que está completa e bem redigida. A Release 1 foi apresentada com sucesso, e apesar de algumas ressalvas, o feedback foi promissor. Apesar disso, ainda é preciso resolver a questão da distribuição dos commits no GitHub.

## Histórico de Versões

| Data | Versão | Descrição | Autor |
| :--------: | :----: | :-------------------: | :-------------: |
| 30/10/2023 | 0.1 | Abertura do documento | [Larissa de Jesus Vieira](https://github.com/VieiraLaris)|

## Objetivos


| Issue | Título | Status |
| :------------------------------------------------------: | :-------------------------------: | :-------------------------------------------------: |
| [#43](https://github.com/unb-mds/2023-2-Squad08/issues/43) | Adequação ao Recommended Community Standards | Concluído |
| [#44](https://github.com/unb-mds/2023-2-Squad08/issues/44) | Criar Slides da Apresentação | Concluído |
| [#45](https://github.com/unb-mds/2023-2-Squad08/issues/45) |Criar simulação do protótipo no figma| Concluído |
| [#46](https://github.com/unb-mds/2023-2-Squad08/issues/46)| Alteração na documentação de escolhas tecnológicas | Concluído |
| [#47](https://github.com/unb-mds/2023-2-Squad08/issues/47)| Finalizar tela Home da aplicação web | Concluído |
| [#48](https://github.com/unb-mds/2023-2-Squad08/issues/48)| Release Note do projeto | Concluído |
| [#49](https://github.com/unb-mds/2023-2-Squad08/issues/49)| Documentação da Sprint | Concluído |
| [#50](https://github.com/unb-mds/2023-2-Squad08/issues/50)| Bug Regex | Concluído |


## Conclusões

A sprint foi concluída com sucesso e todos os objetivos foram alcançados. Porém ainda é necessário distribuir de forma mais equilibrada os commits, que simbolizam contribuição de cada um dos integrantes para o projeto. Ademais, a incorporação dos integrantes em todas as etapas e setores do projeto também deve ser uma meta nas futuras sprints.
25 changes: 25 additions & 0 deletions docs/Sprints/Sprint 08/Planejamento.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
O foco dessa sprint foi continuar a implementação das páginas do front-end de acordo com o protótipo de alta fidelidade e também procurar padrões nos Diários Oficiais para a implemetação do regex. Além disso, algumas das issues tem como objetivo inteirar todos os integrantes do grupo em todas as partes do projeto, tanto a parte do webscrapping e do regex quanto a parte do front-end. Também há uma issue sobre a metodologia XP (Extreme Programming), que será um dos critérios observados na Release 2.

## Histórico de Versões

| Data | Versão | Descrição | Autor |
| :--------: | :----: | :-------------------: | :-------------: |
| 06/11/2023 | 0.1 | Abertura do documento | [Larissa de Jesus Vieira](https://github.com/VieiraLaris)|

## Tamanho da Sprint

**Início:** 30/10/2023

**Término:** 06/11/2023

**Duração:** 7 dias

## Objetivos

| Issue | Título | Responsáveis |
| :------------------------------------------------------: | :-------------------------------: | :-------------------------------------------------: |
| [#54](https://github.com/unb-mds/2023-2-Squad08/issues/54)| Treinamento Front-end | [Ana Clara Borges](https://github.com/anabborges) e [Larissa Vieira](https://github.com/VieiraLaris) |
| [#55](https://github.com/unb-mds/2023-2-Squad08/issues/55)| Treinamento Regex | [Bruno Henrique](https://github.com/bdebatata) e [Bianca Patrocinio](https://github.com/BiancaPatrocinio7) |
| [#56](https://github.com/unb-mds/2023-2-Squad08/issues/56)| Implementação Front-end | [Ana Clara Borges](https://github.com/anabborges), [Larissa Vieira](https://github.com/VieiraLaris) e [Matheus Mello](https://github.com/matheusbmello) |
| [#57](https://github.com/unb-mds/2023-2-Squad08/issues/57)| Buscar padrões para o Regex | [Bianca Patrocinio](https://github.com/BiancaPatrocinio7), [Bruno Henrique](https://github.com/bdebatata) e [Cecilia Quaresma](https://github.com/cqcoding) |
| [#58](https://github.com/unb-mds/2023-2-Squad08/issues/58)| Treinamento Metodologia XP | [Cecilia Quaresma](https://github.com/cqcoding) e [Vitor Feijó](https://github.com/vitorfleonardo) |
24 changes: 24 additions & 0 deletions docs/Sprints/Sprint 08/Resultados.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Essa sprint teve resultados satisfatórios. Depois dos treinamentos, os integrantes do squad estão mais informados sobre o processo e o desenvolvimento de todas as etapas do projeto, inclusive das que não participaram ainda. O grupo também aprendeu sobre a metodologia XP e está mais preparado para aplicá-la. Ademais, houve um bom progresso no regex e no front-end.

## Histórico de Versões

| Data | Versão | Descrição | Autor |
| :--------: | :----: | :-------------------: | :-------------: |
| 06/11/2023 | 0.1 | Abertura do documento | [Larissa de Jesus Vieira](https://github.com/VieiraLaris)|

## Objetivos


| Issue | Título | Status |
| :------------------------------------------------------: | :-------------------------------: | :-------------------------------------------------: |
| [#54](https://github.com/unb-mds/2023-2-Squad08/issues/54) | Treinamento Front-end | Concluído |
| [#55](https://github.com/unb-mds/2023-2-Squad08/issues/55) | Treinamento Regex | Concluído |
| [#56](https://github.com/unb-mds/2023-2-Squad08/issues/56) |Implementação Front-end| Concluído |
| [#57](https://github.com/unb-mds/2023-2-Squad08/issues/57)| Buscar padrões para o Regex | Concluído |
| [#58](https://github.com/unb-mds/2023-2-Squad08/issues/58)| Treinamento Metodologia XP | Concluído |



## Conclusões

A sprint foi concluída com sucesso e todos os objetivos foram alcançados. Porém, ainda é preciso dividir de forma mais equilibrada as metas de cada sprint dentro das issues a fim de que os objetivos fiquem mais claros.
24 changes: 24 additions & 0 deletions docs/Sprints/Sprint 09/Planejamento.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Nessa sprint, um dos objetivos é começar a preparar o front-end para o recebimento das informações nos arquivos json gerados pelo Regex. Dessa forma, o squad foi dividido em duas partes: uma para as adaptações do front-end e outra para continuar a implementar e resolver os problemas do Regex. Além disso, também foram criadas issues para a criação do filtro de pesquisa na página de Pesquisa Avançada e a criação da página de Anomalias.

## Histórico de Versões

| Data | Versão | Descrição | Autor |
| :--------: | :----: | :-------------------: | :-------------: |
| 22/11/2023 | 0.1 | Abertura do documento | [Larissa de Jesus Vieira](https://github.com/VieiraLaris)|

## Tamanho da Sprint

**Início:** 06/11/2023

**Término:** 13/11/2023

**Duração:** 7 dias

## Objetivos

| Issue | Título | Responsáveis |
| :------------------------------------------------------: | :-------------------------------: | :-------------------------------------------------: |
| [#61](https://github.com/unb-mds/2023-2-Squad08/issues/61)| Mudanças no Regex | [Bruno Henrique](https://github.com/bdebatata), [Bianca Patrocinio](https://github.com/BiancaPatrocinio7) e [Cecilia Quaresma](https://github.com/cqcoding) |
| [#62](https://github.com/unb-mds/2023-2-Squad08/issues/62)| Criar filtro da Pesquisa Avançada | [Ana Clara Borges](https://github.com/anabborges) e [Vitor Feijó](https://github.com/vitorfleonardo) |
| [#63](https://github.com/unb-mds/2023-2-Squad08/issues/63)| Criar gráficos a partir de um json | [Larissa Vieira](https://github.com/VieiraLaris) e [Matheus Mello](https://github.com/matheusbmello) |
| [#64](https://github.com/unb-mds/2023-2-Squad08/issues/64)| Implementação da página de anomalias | [Vitor Feijó](https://github.com/vitorfleonardo) e [Ana Clara Borges](https://github.com/anabborges) |
24 changes: 24 additions & 0 deletions docs/Sprints/Sprint 09/Resultados.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Os resultados dessa sprint foram bons. No front-end, foi implementado o filtro de pesquisa e a página de Anomalias, e o grupo também conseguiu criar os gráficos e a tabela a partir de uma estrutura json. Ademais, houve um bom adiantamento do Regex.

## Histórico de Versões

| Data | Versão | Descrição | Autor |
| :--------: | :----: | :-------------------: | :-------------: |
| 22/11/2023 | 0.1 | Abertura do documento | [Larissa de Jesus Vieira](https://github.com/VieiraLaris)|

## Objetivos


| Issue | Título | Status |
| :------------------------------------------------------: | :-------------------------------: | :-------------------------------------------------: |
| [#61](https://github.com/unb-mds/2023-2-Squad08/issues/61) | Mudanças no Regex | Concluído |
| [#62](https://github.com/unb-mds/2023-2-Squad08/issues/62) | Criar filtro da Pesquisa Avançada | Concluído |
| [#63](https://github.com/unb-mds/2023-2-Squad08/issues/63) |Criar gráficos a partir de um json| Concluído |
| [#64](https://github.com/unb-mds/2023-2-Squad08/issues/64)| Implementação da página de anomalias | Concluído |




## Conclusões

A sprint foi concluída e o projeto teve um bom progresso. Porém, grande parte dos problemas que foram encontrados na implementação do Regex tem relação com a identificação dos padrões nos Diários Oficiais, visto que esses padrões mudam bastante nos documentos. Nas próximas sprints, essa questão provavelmente será um dos principais focos.
21 changes: 21 additions & 0 deletions docs/Sprints/Sprint 10/Planejamento.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Nessa sprint, o objetivo principal foi conseguir arrumar os últimos bugs relacionados ao Regex e extrair os dados de nomeações e exonerações dos municípios do Rio Grande do Sul em 2009.

## Histórico de Versões

| Data | Versão | Descrição | Autor |
| :--------: | :----: | :-------------------: | :-------------: |
| 26/11/2023 | 0.1 | Abertura do documento | [Matheus de Mello Barbosa](https://github.com/matheusbmello)|

## Tamanho da Sprint

**Início:** 13/11/2023

**Término:** 20/11/2023

**Duração:** 7 dias

## Objetivos

| Issue | Título | Responsáveis |
| :------------------------------------------------------: | :-------------------------------: | :-------------------------------------------------: |
| [#66](https://github.com/unb-mds/2023-2-Squad08/issues/66)| Extrações de dados de 2009 | [Bruno Henrique](https://github.com/bdebatata), [Matheus de Mello](https://github.com/matheusbmello) e [Vitor Feijó](https://github.com/vitorfleonardo) |
20 changes: 20 additions & 0 deletions docs/Sprints/Sprint 10/Resultados.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Os resultados dessa sprint foram bons. Os bugs do Regex foram resolvidos e após algumas tentativas, todos os dados do ano de 2009 vinham de forma correta.

## Histórico de Versões

| Data | Versão | Descrição | Autor |
| :--------: | :----: | :-------------------: | :-------------: |
| 26/11/2023 | 0.1 | Abertura do documento | [Matheus de Mello Barbosa](https://github.com/matheusbmello)|

## Objetivos


| Issue | Título | Status |
| :------------------------------------------------------: | :-------------------------------: | :-------------------------------------------------: |
| [#66](https://github.com/unb-mds/2023-2-Squad08/issues/66)| Extrações de dados de 2009 | Concluído



## Conclusões

A sprint foi concluída e o projeto teve um bom progresso. Com certeza o ajuste no Regex fará diferença para o bom andamento do projeto
23 changes: 23 additions & 0 deletions docs/Sprints/Sprint 11/Planejamento.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Essa Sprint foi bastante movimentada pela quantidade de temas diferentes que foram explorados.

## Histórico de Versões

| Data | Versão | Descrição | Autor |
| :--------: | :----: | :-------------------: | :-------------: |
| 04/12/2023 | 0.1 | Abertura do documento | [Matheus de Mello Barbosa](https://github.com/matheusbmello)|

## Tamanho da Sprint

**Início:** 20/11/2023

**Término:** 27/11/2023

**Duração:** 7 dias

## Objetivos

| Issue | Título | Responsáveis |
| :------------------------------------------------------: | :-------------------------------: | :-------------------------------------------------: |
| [#67](https://github.com/unb-mds/2023-2-Squad08/issues/67)| Análise de dados com Regex | [Bruno Henrique](https://github.com/bdebatata), [Bianca Patrocínio](https://github.com/BiancaPatrocinio7) |
| [#68](https://github.com/unb-mds/2023-2-Squad08/issues/68)| Bibliotecas para Processamento de Linguagem Natural (NLP) | [Cecília Quaresma](https://github.com/cqcoding), [Larissa de Jesus](https://github.com/VieiraLaris) , [Vitor Feijó](https://github.com/vitorfleonardo) |
| [#69](https://github.com/unb-mds/2023-2-Squad08/issues/69)| Explorando o Conceito e Implementação de Pipelines em DS | [Ana Borges](https://github.com/anabborges) ,[Matheus de Mello Barbosa](https://github.com/matheusbmello)|
21 changes: 21 additions & 0 deletions docs/Sprints/Sprint 11/Resultados.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Os resultados dessa Issue foram satisfatórios, a única Issue que acabou tendo problema foi a Issue 69 onde cada membro entendeu a proposta de forma diferente

## Histórico de Versões

| Data | Versão | Descrição | Autor |
| :--------: | :----: | :-------------------: | :-------------: |
| 04/12/2023 | 0.1 | Abertura do documento | [Matheus de Mello Barbosa](https://github.com/matheusbmello)|

## Objetivos


| Issue | Título | Status |
| :------------------------------------------------------: | :-------------------------------: | :-------------------------------------------------: |
| [#67](https://github.com/unb-mds/2023-2-Squad08/issues/67)| Análise de dados com Regex | Concluído
| [#68](https://github.com/unb-mds/2023-2-Squad08/issues/68)| Bibliotecas para Processamento de Linguagem Natural (NLP) | Concluído
| [#69](https://github.com/unb-mds/2023-2-Squad08/issues/69)| Explorando o Conceito e Implementação de Pipelines em DS | Concluído


## Conclusões

A sprint foi concluída e o projeto teve um bom progresso. Apenas deve ser lembrado a comunicação geral de todos os membros para uma melhor performace geral da equipe.
Loading
Loading