Skip to content

Commit

Permalink
Merge pull request #226 from fga-eps-mds/doc/#215-atualizacao-dos-doc…
Browse files Browse the repository at this point in the history
…umentos

Doc/#215 atualizacao dos documentos
  • Loading branch information
pedro-cella authored Dec 13, 2023
2 parents 412f6a0 + cab3f5e commit ea84d48
Show file tree
Hide file tree
Showing 21 changed files with 212 additions and 14 deletions.
Binary file added docs/assets/imagens/banco_de_dados/DER.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/imagens/banco_de_dados/DER.png
Binary file not shown.
Binary file added docs/assets/imagens/banco_de_dados/DLD.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/imagens/banco_de_dados/DLD.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/imagens/banco_de_dados/dicionario_de_dados/LIKE.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions docs/encerramento/postmortem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Documento de Arquitetura

## Introdução

O presente documento tem como finalidade compartilhar as experiências vividas pela equipe durante o desenvolvimento do projeto, além de promover uma autorreflexão. Também visa auxiliar outras equipes na condução de futuros projetos.

## Pontos Fortes

- Fluxo constante de entregas para os usuários.
- Cobertura do escopo do MVP, ao qual a equipe se comprometeu no início do projeto.

## Pontos Fracos

- Frontend não tem a mesma qualidade do backend (pode-se analisar esse fato pelo notebook da disciplina).
- Não tivemos tempo hábil para terminar todos os incrementos.

## Aprendizado

- Nenhum membro do time tinha conhecimento prévio com React Native. Os membros de MDS nesse projeto tiveram o primeiro contato com tecnologias como Docker e Git, o que não foi impeditivo para um aprendizado empenhado.

## Recomendações

- Ter uma política de testes desde o dia 0 do projeto, tanto para backend quanto para frontend. Recomendamos fortemente a configuração de um container de testes com a versão correta que será usada pela ferramenta do GitHub Actions, que gerará o relatório para o Sonar. Devido a diferentes versões ou configurações, tivemos discrepâncias na porcentagem de cobertura do frontend durante todo o projeto.

## Histórico de Versão

| Versão | Data | Descrição | Autores |
| ------ | ---------- | --------------------- | --------------- |
| 1.0 | 10/12/2023 | Abertura do documento | Gustavo Afonso |
121 changes: 121 additions & 0 deletions docs/encerramento/relatorio_encerramento.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# Relatório de Encerramento

## Introdução

O presente documento tem como objetivo realizar uma análise comparativa entre o planejado e o efetivamente executado durante o desenvolvimento do projeto. Essa análise sintetiza alguns aspectos essenciais, a saber: backlog, custo, qualidade e riscos. Esse paralelo é fundamental para ilustrar a perspectiva inicial da equipe e o que foi efetivamente concluído ao longo da execução do projeto. Além disso, serve como um guia para futuros mantenedores do projeto, fornecendo insights cruciais sobre o planejamento e execução da solução apresentada.

---

## Backlog

### Planejado

#### MVP

- [[US-01] CRUD de Usuário](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/88)
- [[US-02] CRUD de publicação do fórum](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/111)
- [[US-03] Criação da moderação](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/107)
- [[US-04] CRUD de rotina](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/114)
- [[US-05] CRUD de Idosos](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/112)
- [[US-06] Criação das notificações](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/110)
- [[US-07] Adição da agenda calendário](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/177)
- [[US-08] CRUD de informações de saúde do idoso](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/116)

#### Incremento

- [[US-09] Criação da interação com o fórum](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/109)
- [[US-10] Senha (recuperação e indicadores)](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/113)

### Executadas e Aceitas pelo Cliente

- [[US-01] CRUD de Usuário](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/88)
- [[US-02] CRUD de publicação do fórum](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/111)
- [[US-03] Criação da moderação](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/107)
- [[US-04] CRUD de rotina](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/114)
- [[US-05] CRUD de Idosos](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/112)
- [[US-07] Adição da agenda calendário](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/issues/177)

---

## Custo

---

## Qualidade

Com a finalidade de assegurar a qualidade do produto, em suas diversas nuances, foram tomadas diversas providências, como a validação semanal das entregas junto aos clientes, a validação dos protótipos, implementação de testes e claro os quesitos de qualidade estabelecidos na disciplina e detalhados no [notebook de análise](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/blob/main/Analytics/analytics.ipynb). Foi estabelecido como objetivo pelo time atingir 80% de cobertura de testes em todos os repositórios do projeto, 0 bugs e 0 falhas de segurança.

O time atingiu essa meta, com exceção do repositório de frontend, tal fato se deve à falta de experiência prévia dos membros com testes de frontend e com a tecnologia escolhida para o mesmo, além de algumas falhas ao executar desde a primeira sprint os testes de frontend de maneira correta.

Os demais repositórios atingiram e até superaram a expectativa de testes e qualidade proposta pela equipe.

### Resumo da análise em 10/12/23

| Repositório | Cobertura | Duplicações | Bugs | Code Smells |
|-------------|-----------|-------------|------|-------------|
| Front | 60.9% | 15.08% | 1 | 23 |
| APIForum | 99.4% | 0.0% | 0 | 7 |
| APISaude | 99.3% | 0.0% | 0 | 7 |
| APIUsuario | 99.2% | 0.0% | 0 | 9 |

---

## Risco

### Riscos Planejados

#### Externos

- Falta de cliente real

- Mudança dos responsáveis pelo projeto

- Indisponibilidade do cliente

- Projeto cancelado

- Ausência do professor na disciplina por motivos de saúde

#### Organizacional

- Divergência de horários dos membros da equipes

- Desistências da disciplina

- Dependências de atividades

#### Técnicos

- Dificuldades com as tecnologias

- Alterações das tecnologias

#### Gerencia

- Alterações de escopo

- Presenças dos membros nas reuniões

- Baixa produtividade dos membros

- Problemas de comunicação

- Cronograma

### Riscos Enfrentados

- Desistência de um membro da equipe

- Dificuldade da equipe com novas tecnologias, resultando em uma participação mais ativa no frontend

- Divergência de horários, resultando em dificuldades para realizar pareamentos

- Dificuldade na comunicação entre os membros do grupo, resultando na centralização das comunicações em apenas 1 pessoa

---

## Histórico de Versão

| Versão | Data | Descrição | Autores |
| ------ | ---------- | --------------------- | --------------- |
| 1.0 | 10/12/2023 | Abertura do documento | Gustavo Afonso |
37 changes: 28 additions & 9 deletions docs/planejamento/metodologia.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Metodologias


## Introdução

<p align="justify"> Este documento descreve o processo completo utilizado no desenvolvimento do projeto GEROcuidado. Para alcançar esse objetivo, adotamos metodologias ágeis de desenvolvimento de software, incluindo Scrum e XP. </p>
Expand All @@ -18,12 +17,15 @@
<p align="justify">Durante o projeto GEROcuidado, os artefatos usados são: backlog do produto (<i>product backlog</i>) e sprints. Os ritos usados são: planejamento da sprint (<i>planing</i>), <i>daily</i> e <i>review</i>. </p>

### <i>Product Backlog</i>

<p align="justify">O <i>Product Backlog</i> é uma lista de tarefas priorizadas que incluem todas as atividades necessárias para concluir um projeto, incluindo requisitos funcionais que agregam valor ao negócio (PEREIRA, 2007). Ou seja, é um conjunto de funcionalidades e requisitos que deverão ser entregues. </p>

### <i>Sprints</i>

<p align="justify">No Scrum a Sprint é uma iteração que dura de duas a quatro semanas, no qual são desenvolvidos incrementos do produto.</p>

### <i>Planning</i>

<p align="justify">A <i>Sprint Planning</i> é um rito em que a iteração é planejada, em que será definido o que será feito, ou seja, quais itens do backlog serão realizados na <i>sprint </i>.</p>

<p align="justify"> Neste projeto a reunião de planejamento ocorre a cada duas semanas.</p>
Expand All @@ -33,10 +35,15 @@
<p align="justify"> A <i>Daily</i> é uma reunião diária de acompanhamento da equipe com o objetivo de que cada participante relate seu status e possíveis obstáculos para a conclusão do projeto. Neste projeto a reunião dura em média quinze minutos. </p>

### <i>Sprint Review</i>

<p align="justify"> A <i>Sprint Review</i> é uma reunião que ocorre no final da <i>sprint</i> em que é feita uma revisão do que foi feito, tendo uma visão geral de como está o produto </p>

### <i>Sprint Retrospective</i>

A <i>Sprint Retrospective</i> é uma reunião realizada no final de uma <i>sprint</i> no contexto da metodologia ágil, como o Scrum. Nesta reunião, a equipe Scrum se reúne para refletir sobre o processo de trabalho durante a <i>sprint</i> recentemente concluída. O principal objetivo da <i>Sprint Retrospective</i> é identificar oportunidades de melhoria, discutir o que funcionou bem e o que pode ser aprimorado no próximo ciclo de desenvolvimento.

## XP

<p align="justify"> O Extreme Programming (XP) é uma metodologia ágil que nasceu com o intuito de tentar solucionar os problemas que eram causados pelas metodologias tradicionais. O XP tem quatro princípios: Comunicação, Simplicidade, Feedback e Coragem. O XP tem diversos tipos de práticas, totalizando 12 tipos, entre elas a que serão utilizadas no projeto serão: programação em pares, releases curtas, código coletivo e cliente presente.
</p>

Expand All @@ -45,7 +52,6 @@
<p align="justify"> A programação em pares ocorre quando dois programadores escrevem o código juntos em um mesmo computador.
</p>


### Releases curtas

<p align="justify"> São feitas pequenas releases do software, pequenas versões funcionais, para ser entregue ao cliente antes do prazo.
Expand All @@ -61,10 +67,26 @@
<p align="justify"> O desenvolvimento do software é feito com a presença do cliente, ou seja, ele sempre está em contato com a equipe de desenvolvimento.
</p>


## Kanban

<p align="justify"> O Kanban é um sistema de gestão de trabalho, que possui como objetivo a definição de um fluxo de trabalho. Além disso tem como foco produtividade e organização das entregas. O kanban é mais conhecido devido o uso do quadro kanban, em que o mesmo é dividido, normalmente em cinco colunas: backlog, to do, doing, review e done. Na coluna de backlog fica os cards com as atividades que precisam ser feitas para realização do trabalho completo. Na coluna to do ficam os cards que precisam ser feitos durante a spring, quando começa a atividade o card é movido para coluna de doing, quando terminado vai para coluna de revisão e por último quando tudo finalizado vai para done. </p>

## PMBOK

<p>O PMBOK (Project Management Body of Knowledge) é um guia de boas práticas em gerenciamento de projetos, desenvolvido pelo PMI (Project Management Institute). Ele oferece um conjunto abrangente de diretrizes e terminologias para o gerenciamento efetivo de projetos em diferentes setores e indústrias.<br>
<p>
A metodologia do PMBOK se baseia em cinco grupos de processos e dez áreas de conhecimento. Os cinco grupos de processos são:
<ol>
<li>Iniciação: Envolve a definição e autorização do projeto ou fase.</li>
<li>Planejamento: Desenvolve o plano do projeto e define os objetivos e as atividades necessárias.</li>
<li>Execução: Concentra-se na coordenação de pessoas e recursos para executar o plano do projeto.</li>
<li>Monitoramento e Controle: Acompanha, revisa e regula o progresso e o desempenho do projeto.</li>
<li>Encerramento: Formaliza a aceitação do projeto e garante a conclusão adequada de todas as atividades.</li>
</ol>
As dez áreas de conhecimento do PMBOK incluem integração, escopo, tempo, custo, qualidade, recursos humanos, comunicação, riscos, aquisições e partes interessadas.
</p>

</p>

## Referências

Expand All @@ -73,17 +95,14 @@ CAROLI, Paulo. Lean inception. São Paulo, BR: Caroli. org, 2017.
CRUZ, Fábio. Scrum e PMBOK unidos no Gerenciamento de Projetos. Brasport, 2013.

FADEL, Aline Cristine; SILVEIRA, Henrique da Mota.Metodologias ágeis no contexto de
desenvolvimento de software: XP, Scrum e Lean.
desenvolvimento de software: XP, Scrum e Lean.

PEREIRA, Paulo; TORREÃO, Paula; MARÇAL, Ana Sofia. Entendendo Scrum para gerenciar projetos de forma ágil. Mundo PM, v. 1, p. 3-11, 2007.

SOFIA, Bianca; OLIVEIRA, Lorrany. Metodologias do grupo AMIS. Disponível em: https://github.com/fga-eps-mds/2023.1-Amis-Doc/blob/main/docs/organization/methodology.md. Acesso em 09 jul 2022


## Histórico de versões


| Versão | Data | Descrição | Autores |
| ------ | ---------- | --------- | ------- |
| Versão | Data | Descrição | Autores |
| ------ | ---------- | --------------------- | ----------- |
| 1.0 | 07/09/2023 | Abertura do documento | Pedro Cella |

24 changes: 24 additions & 0 deletions docs/planejamento/quadro_conhecimento.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,27 @@ O quadro sofrerá alteração quando começar as Sprints, visto que o objetivo s
## Quadro de Conhecimento da Sprint 2 (31/10):

<iframe width="2000" height="500" src="https://docs.google.com/spreadsheets/d/e/2PACX-1vQBIt3ITuOTg6yWgtaCHSE02-C0hjBGbOp0iQBijc8RRikOwvrIwmQ9zm4P63kiJ60yrXa_oKJMLgSC/pubhtml?gid=501327172&amp;single=true&amp;widget=true&amp;headers=false"></iframe>

## Quadro de Conhecimento da Sprint 3 (07/11):

<iframe width="2000" height="500" src="https://docs.google.com/spreadsheets/d/e/2PACX-1vQBIt3ITuOTg6yWgtaCHSE02-C0hjBGbOp0iQBijc8RRikOwvrIwmQ9zm4P63kiJ60yrXa_oKJMLgSC/pubhtml?gid=2045313925&amp;single=true&amp;widget=true&amp;headers=false"></iframe>

## Quadro de Conhecimento da Sprint 4 (14/11):

<iframe width="2000" height="500" src="https://docs.google.com/spreadsheets/d/e/2PACX-1vQBIt3ITuOTg6yWgtaCHSE02-C0hjBGbOp0iQBijc8RRikOwvrIwmQ9zm4P63kiJ60yrXa_oKJMLgSC/pubhtml?gid=1207298130&amp;single=true&amp;widget=true&amp;headers=false"></iframe>

## Quadro de Conhecimento da Sprint 5 (21/11):

<iframe width="2000" height="500" src="https://docs.google.com/spreadsheets/d/e/2PACX-1vQBIt3ITuOTg6yWgtaCHSE02-C0hjBGbOp0iQBijc8RRikOwvrIwmQ9zm4P63kiJ60yrXa_oKJMLgSC/pubhtml?gid=1468540938&amp;single=true&amp;widget=true&amp;headers=false"></iframe>

## Quadro de Conhecimento da Sprint 6 (28/11):

<iframe width="2000" height="500" src="https://docs.google.com/spreadsheets/d/e/2PACX-1vQBIt3ITuOTg6yWgtaCHSE02-C0hjBGbOp0iQBijc8RRikOwvrIwmQ9zm4P63kiJ60yrXa_oKJMLgSC/pubhtml?gid=329419324&amp;single=true&amp;widget=true&amp;headers=false"></iframe>

## Quadro de Conhecimento da Sprint 7 (05/12):

<iframe width="2000" height="500" src="https://docs.google.com/spreadsheets/d/e/2PACX-1vQBIt3ITuOTg6yWgtaCHSE02-C0hjBGbOp0iQBijc8RRikOwvrIwmQ9zm4P63kiJ60yrXa_oKJMLgSC/pubhtml?gid=2040579967&amp;single=true&amp;widget=true&amp;headers=false"></iframe>

## Quadro de Conhecimento da Sprint 8 (11/12):

<iframe width="2000" height="500" src="https://docs.google.com/spreadsheets/d/e/2PACX-1vQBIt3ITuOTg6yWgtaCHSE02-C0hjBGbOp0iQBijc8RRikOwvrIwmQ9zm4P63kiJ60yrXa_oKJMLgSC/pubhtml?gid=1840253379&amp;single=true&amp;widget=true&amp;headers=false"></iframe>
8 changes: 4 additions & 4 deletions docs/produto/banco_de_dados.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ Este documento tem por objetivo reunir os principais documentos produzidos refer

<p>O Diagrama Entidade-Relacionamento (DER) é uma representação gráfica amplamente utilizada no projeto de bancos de dados. Ele descreve as entidades (objetos), seus atributos (características) e os relacionamentos entre as entidades. Os retângulos representam as entidades, as elipses indicam os atributos e as linhas conectam as entidades para mostrar como elas se relacionam. O DER é uma ferramenta fundamental para visualizar e planejar a estrutura de um banco de dados antes da implementação, ajudando a definir como os dados são armazenados e acessados </p>

![DER](../assets/imagens/banco_de_dados/DER.png)
![DER](../assets/imagens/banco_de_dados/DER.jpeg)

### 2.3 DLD

<p>
O Diagrama Lógico de Dados (DLD) é uma representação gráfica que ilustra a estrutura lógica de um banco de dados. Nesse diagrama, são exibidas informações cruciais, como os tipos de atributos associados a cada entidade, bem como as chaves estrangeiras e restrições, como a chave única (unique key). Seu propósito fundamental é fornecer uma representação estruturada e específica da maneira como o banco de dados deve ser implementado. Em resumo, o DLD funciona como uma representação visual que orienta a implementação efetiva do banco de dados.</p>

![DLD](../assets/imagens/banco_de_dados/DLD.png)
![DLD](../assets/imagens/banco_de_dados/DLD.jpeg)

### 2.4 Dicionário de Dados

Expand All @@ -50,9 +50,9 @@ Um Dicionário de Dados é uma referência essencial em gerenciamento de dados.

![USUARIO](../assets/imagens/banco_de_dados/dicionario_de_dados/USUARIO.png)

### Paciente
### Idoso

![Paciente](../assets/imagens/banco_de_dados/dicionario_de_dados/PACIENTE.png)
![Idoso](../assets/imagens/banco_de_dados/dicionario_de_dados/PACIENTE.png)

### Métricas de saúde

Expand Down
Empty file added docs/produto/post_mortem.md
Empty file.
7 changes: 6 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ nav:
- Documento de Banco de Dados: produto/banco_de_dados.md
- Guia de estilo: produto/guia_de_estilo.md
- Protótipo: produto/prototipo.md
- Post Mortem: produto/post_mortem.md
- Lean Inception:
- Lean Inception: lean_inception/lean_inception.md
- Kick-off: lean_inception/kickoff.md
Expand Down Expand Up @@ -139,7 +140,11 @@ nav:
- Monitoramento:
- Agile EVM: monitoramento/EVM.md
- Burndown de Riscos: monitoramento/burndown-riscos.md
- Analytics: monitoramento/analytics.md
- Analytics: monitoramento/analytics.md

- Encerramento:
- Relatorio de encerramento do projeto: encerramento/relatorio_encerramento.md
- Postmortem: encerramento/postmortem.md

plugins:
- search
Expand Down

0 comments on commit ea84d48

Please sign in to comment.