Skip to content

Commit

Permalink
Merge branch 'main' into doc#88/arquitetura
Browse files Browse the repository at this point in the history
  • Loading branch information
dartmol203 authored Dec 9, 2024
2 parents 54d0fc6 + 1436081 commit d6eafee
Show file tree
Hide file tree
Showing 9 changed files with 232 additions and 5 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions docs/equipe/gestao_de_conhecimentos.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
| **Versão** | **Data** | **Modificação** | **Responsável** |
| :-: | :-: | :-: | :-: |
| 1.0 | 02/12/24 | Criação do documento | Gabriel Mariano e André Corrêa |
| 1.1 | 08/12/24 | Adição da planilha 3 | André Corrêa e Gabriel Mariano|

*Tabela 1: Versionamento*

Expand All @@ -27,3 +28,11 @@ As tabelas de conhecimento preenchidas ao longo do semestre podem ser encontrada
<img src="../../assets/conhecimento/conhecimento_07_11_24.png" alt="Planilha de Conhecimentos: 07/11/2024" width="1000"/>

*Figura 2: Planilha de Conhecimentos de 07/11/2024*

### Terceira Coleta (28/11/2024)

<img src="../../assets/conhecimento/conhecimento_28_11_24.png" alt="Planilha de Conhecimentos: 28/11/2024" width="1000"/>

*Figura 2: Planilha de Conhecimentos de 28/11/2024*

Para ver todas as planilhas pode-se acessar o seguinte [link](https://docs.google.com/spreadsheets/d/1RBjz0P8PlI9E7Ih7S0mFAS8CW2lDqglOjgUDL6Qg7gQ/edit?usp=sharing)
3 changes: 2 additions & 1 deletion docs/equipe/gestao_de_pareamento.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
| **Versão** | **Data** | **Modificação** | **Responsável** |
| :-: | :-: | :-: | :-: |
| 1.0 | 02/12/24 | Criação do documento | Gabriel Mariano e André Corrêa |
| 1.1| 08/12/24 | adição de pareamento para US03 | Gabriel Mariano e André Corrêa |

*Tabela 1: Versionamento*

Expand All @@ -22,9 +23,9 @@ Abaixo, a disposição dos pareamentos ao longo do projeto:
| :-: | :-: | :-: | :-: |
| [**US01**](https://github.com/fga-eps-mds/2024.2-ARANDU-DOC/issues/58) | Realizar Autenticação | Gabriel Costa, João Filipe, Danilo de Melo, Yasmin Nascimento e Dylan Cavalcante | **Pareamento 01**: Gabriel Costa, Yasmin Nascimento e Dylan Cavalcante </br> **Pareamento 02**: Gabriel Costa, Danilo de Melo e João Filipe |
| [**US02**](https://github.com/fga-eps-mds/2024.2-ARANDU-DOC/issues/59) | Gerenciar Usuário | André Corrêa, Gabriel Mariano, Eduardo de Melo, Ricardo Henrique, Daniel Rodrigues, Marina Galdi e Isabella Choukaira | **Pareamento 01**: André Corrêa, Gabriel Mariano, Marina Galdi e Isabella Choukaira </br> **Pareamento 02**: André Corrêa, Gabriel Mariano, Eduardo de Melo, Ricardo Henrique e Daniel Rodrigues |
| [**US03**](https://github.com/fga-eps-mds/2024.2-ARANDU-DOC/issues/60) | Recuperar Conta | André Corrêa, Gabriel Mariano, Gabriel Costa, Danilo de Melo e João Filipe | **Pareamento 01**: André Corrêa, Gabriel Mariano, Gabriel Costa, Danilo de Melo e João Filipe|

<!--
| [**US03**](https://github.com/fga-eps-mds/2024.2-ARANDU-DOC/issues/60) | Recuperar Conta | a definir | a definir |
| [**US04**](https://github.com/fga-eps-mds/2024.2-ARANDU-DOC/issues/66) | Acessar Disciplinas | a definir | a definir |
| [**US05**](https://github.com/fga-eps-mds/2024.2-ARANDU-DOC/issues/64) | Acessar Jornadas | a definir | a definir |
| [**US06**](https://github.com/fga-eps-mds/2024.2-ARANDU-DOC/issues/65) | Acessar Trilhas | a definir | a definir |
Expand Down
3 changes: 2 additions & 1 deletion docs/equipe/planejamento_de_comunicacao.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
| **Versão** | **Data** | **Modificação** | **Responsável** |
| :-: | :-: | :-: | :-: |
| 1.0 | 02/12/24 | Criação do documento | Gabriel Mariano e André Corrêa |
| 1.1 | 08/12/24 | Adição do Link para o When2Meet | Gabriel Mariano e André Corrêa |

*Tabela 1: Versionamento*

Expand Down Expand Up @@ -35,7 +36,7 @@ Para além da definição de ferramentas de comunicação interna e externa da e

### Disponibilidade

A planilha abaixo pode ser encontrada com mais detalhes quanto a disposição individual dos membros da equipe na ferramenta [**When2Meet**](https://www.when2meet.com/).
A planilha abaixo pode ser encontrada com mais detalhes quanto a disposição individual dos membros da equipe na ferramenta [**When2Meet**](https://www.when2meet.com/?27101755-Ux3Wx).

<img src="../../assets/disponibilidade.png" alt="Planilha de Disponibilidade" width="400"/>

Expand Down
28 changes: 28 additions & 0 deletions docs/guias/IDV.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Guia de Identidade visual

## Histórico de versões

| Versão | Data | Alteração | Responsável |
| :----: | :------: | :-------------------------------------: | :------------------------: |
| 1.0.0 | 08/12/24 | Criação | André Corrêa, Gabriel Costa e Gabriel Mariano |

## 1. Introdução

Esse documento visa apresentar o guia de identidade visual desenvolvido pela equipe.

## 2. Descrição

O guia de identidade visual busca trazer diretivas de cores, fontes, formatos para o desenvolvimento das aplicações. tal guia foi desenvolvido no ambiente figma e foi validado e aprovado pelo cliente.

## 3. Documento

<iframe style="border: 1px solid rgba(0, 0, 0, 0.1);" width="800" height="450" src="https://embed.figma.com/design/lGgbvDwyutTudeTBpzdGzM/Arandu-(v.1.0)?node-id=28-43&embed-host=share" allowfullscreen></iframe>


## 4. Protótipos

Além disso, também estão sendo desenvolvidos protótipos para apoiarem o desenvolvimento dos sistemas, todos os protótipos são validos pelo cliente antes de serem levados para a produção.

<iframe style="border: 1px solid rgba(0, 0, 0, 0.1);" width="800" height="450" src="https://embed.figma.com/design/lGgbvDwyutTudeTBpzdGzM/Arandu-(v.1.0)?node-id=0-1&embed-host=share" allowfullscreen></iframe>

O guia e protótipos podem ser encontrados na integra em: [Figma](https://www.figma.com/design/lGgbvDwyutTudeTBpzdGzM/Arandu-(v.1.0)?node-id=28-43&t=P484QBUL43jwIroS-1)
42 changes: 42 additions & 0 deletions docs/projeto/custos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Planejamento de custos

## Histórico de versões

| Versão | Data | Alteração | Responsável |
| :----: | :------: | :-------------------------------------: | :------------------------: |
| 1.1.0 | 08/12/24 | Criação | André Corrêa e Gabriel Mariano |

## 1. Introdução

Esse documento visa apresentar o planejamento de custos do projeto, fazendo a ligação entre as planilhas dinâmicas e uma explicação teórica de como foi feito esse planejamento.

## 2. Descrição

Para cálculo do custo foi necessário dividir essa área em 3 subáreas, sendo elas: pessoas, equipamento e infraestrutura, tal método de cálculo é explicitado abaixo:

### Pessoas

Para calcular o custo por pessoa, foi realizado uma estimativa de custo-hora para cara participante da equipe, para isso, utilizamos como base o valor médio que a UnB recebeu por aluno no ano de 2018 e corrigimos a inflação para o mês de outubro de 2024.

Além disso, foi realizada uma média de quantos créditos um aluno presta por semestre, todos esses cálculos estão explicitados na planilha de custos.

### Equipamento

Para o cálculo de custo em equipamentos, foi considerado o custo adquirir equipamentos para a equipe de desenvolvimento, por exemplo, computadores e fones para reuniões.

Foi cotado também um computador mac para que possa ser desenvolvido um sistema para diferentes sistemas.

Para maior detalhamento, vide planilha na integra.

### Infraestrutura

Para o estimar o custo de infraestrutura, foram considerados o consumo de agua, energia e internet na região de Brasília - DF

os valores de base podem ser encontrados na planilha abaixo.
## 3. Documento

<div width= 900px>
<iframe src="https://docs.google.com/spreadsheets/d/e/2PACX-1vQDhgzyWU9-_FceQ_muS4N4YleUWVUwxMXxHOVR7PEAYGTwNhlxBG6UnuNSGv9iZNiO1rsmb6z1YqLW/pubhtml?widget=true&amp;headers=false" width="900" height="700"></iframe>
</div>

[Link para acessar a planilha](https://docs.google.com/spreadsheets/d/1jqF0V4F1PVVlrQ0ySFKpQiEWR2LGs0UUea_tIe5XZnA/edit?usp=sharing)
101 changes: 101 additions & 0 deletions docs/projeto/planejamento_de_risco.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Planejamento de Risco

## Versionamento

| **Versão** | **Data** | **Modificação** | **Responsável** |
| :-: | :-: | :-: | :-: |
| 0.1 | 08/12/24 | Criação do documento | Gabriel Mariano, André Corrêa e Gabriel Costa |

*Tabela 1: Versionamento*

---

## Objetivos

Riscos são inerentes ao desenvolvimento de software, possuindo diferentes fontes (sejam internas ou externas à equipe, por exemplo), graus de previsibilidade e probabilidade e diferentes impactos na execução do projeto.

Para tal, a partir deste documento, objetiva-se estabelecer critérios para o acompanhamento do risco ao longo do projeto. Para além disso, propoẽ-se o efetivo monitoramento dos mesmos, com atualização constante no período citado.

## Classificações

### Quanto à Fonte

No tocante às origens dos riscos do projeto, foram determinadas algumas fontes para tais, conforme pode ser visto abaixo:

| **Fonte** | **Característica** |
| :-: | :-: |
| **Interno** | Riscos originados internamente ao projeto, isto é, no contexto do ambiente de trabalho e comunicação da equipe. |
| **Externo** | Riscos originados externamente ao projeto que possuem impacto direto ou indireto no mesmo. |
| **Gerencial** | Riscos originados a partir das atividades gerenciais da equipe. |
| **Técnico** | Riscos originados a partir de questões técnicas a serem executadas pela equipe. |
| **Pessoal** | Riscos originados a partir da equipe de desenvolvimento do projeto. |

*Tabela 2: Classificação dos riscos quanto à fonte*

### Quanto à Probabilidade

No tocante à probabilidade da ocorrência dos riscos do projeto, foram estabelecidos cinco graus a partir da divisão das probabilidades em *buckets*, para além da definição de *scores* para cada nível de probabilidade, como pode ser visto abaixo:

| **Nível de Risco** | **Grau de Probabilidade** | **Score** |
| :-: | :-: | :-: |
| Raro | < 0.1 | 0.1 |
| Improvável | 0.1 ~ 0.25 | 0.2 |
| Moderado | 0.25 ~ 0.5 | 0.4 |
| Provável | 0.5 ~ 0.75 | 0.6 |
| Quase Certo | > 0.75 | 0.8 |

*Tabela 3: Classificação dos riscos quanto à probabilidade*

### Quanto ao Impacto

No tocante ao impacto de cada risco no projeto, foram estabelecidos cinco graus de impacto a partir da divisão em *buckets*, para além da definição de *scores* para cada nível de impacto, como pode ser visto abaixo:

| **Nível de Impacto** | **Grau de Impacto** | **Score** |
| :-: | :-: | :-: |
| Quase Nulo | < 0.1 | 0.1 |
| Baixo | 0.1 ~ 0.25 | 0.2 |
| Moderado | 0.25 ~ 0.5 | 0.4 |
| Alto | 0.5 ~ 0.75 | 0.6 |
| Altíssimo | > 0.75 | 0.8 |

*Tabela 4: Classificação dos riscos quanto ao impacto*

### Quanto ao *Score*

A partir da definição do grau de probabilidade (*P*) e do nível de impacto (*I*) para cada risco, será calculado o *score* (*S*) de tal risco a partir da multiplicação dos scores para ambos os fatores, podendo assim obter uma definição quantitativa dos riscos para cada sprint.

$$
S = P * I
$$

*Fórmula 1: Cálculo do Score de Criticidade do Risco*

## Definição dos Riscos

A definição de riscos foi criada em uma planilha externa, a qual pode ser encontrada [NESSE LINK](https://docs.google.com/spreadsheets/d/1o43ntaEg_9Ez_WUeEvSivVT0YTsDGu8CkFLDqTU740E/edit?usp=sharing) e pode ser vista abaixo:

<iframe src="https://docs.google.com/spreadsheets/d/e/2PACX-1vSFCkM9vnQzb9I3ABhfvwZmqgLRthZEOeVp5lc45L3PjIHKW0aZ3qgj3ouBfVX8VeW2W8ke36tJlH_t/pubhtml?gid=1692350857&amp;single=true&amp;widget=true&amp;headers=false" width=650 height=600></iframe>

## Acompanhamento dos Riscos

Ainda na planilha acima, foram criadas abas para a avaliação do impacto e probabilidade de cada item de risco citado anteriormente, com o cálculo do *score* de cada um, para além do acompanhamento da evolução do risco por sprints em um gráfico, como pode ser acessado [NESSE LINK](https://docs.google.com/spreadsheets/d/1o43ntaEg_9Ez_WUeEvSivVT0YTsDGu8CkFLDqTU740E/edit?usp=sharing) ou então visto abaixo:

<iframe src="https://docs.google.com/spreadsheets/d/e/2PACX-1vSFCkM9vnQzb9I3ABhfvwZmqgLRthZEOeVp5lc45L3PjIHKW0aZ3qgj3ouBfVX8VeW2W8ke36tJlH_t/pubhtml?widget=true&amp;headers=false" width=1000 height=600></iframe>

## Plano de Ação

O plano de ação para cada risco elicitado também se encontra na tabela disponibilizada [NESSE LINK](https://docs.google.com/spreadsheets/d/1o43ntaEg_9Ez_WUeEvSivVT0YTsDGu8CkFLDqTU740E/edit?usp=sharing) e abaixo:

<iframe src="https://docs.google.com/spreadsheets/d/e/2PACX-1vSFCkM9vnQzb9I3ABhfvwZmqgLRthZEOeVp5lc45L3PjIHKW0aZ3qgj3ouBfVX8VeW2W8ke36tJlH_t/pubhtml?widget=true&amp;headers=false" width=1000 height=600></iframe>

## Referências

ROCHA, C.; NERI, H. R. Gestão de Portfólios e Projetos de Software - Fases ou Grupos de Processo: Planejamento II. Disponível em [repositório do GitHub](https://github.com/fga-eps-mds/A-Disciplina-MDS-EPS/blob/master/GPP_Material/06%20-%20Planejamento%20II/main.pdf).

JUNCKES, G. D.; MORGADO, P. Gerência de riscos em desenvolvimento de software. Disponível em: <https://www.devmedia.com.br/gerencia-de-riscos-em-desenvolvimento-de-software/28506>.

Calculus (2024.1). Estrutura Analítica de Riscos. Disponível em: <https://fga-eps-mds.github.io/2024.1-CALCULUS-DOC/planos/planos_riscos/>.

MeasureSoftGram (2024.1). Plano de Gestão de Riscos. Disponível em: <https://fga-eps-mds.github.io/2024.1-MeasureSoftGram-DOC/planejamento/riscos/>.

Sentinela (2024.1). Riscos do Projeto Sentinela. Disponível em: <https://fga-eps-mds.github.io/2024.1-SENTINELA-DOC/gestao/riscos/>.
44 changes: 44 additions & 0 deletions docs/projeto/qualidade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Planejamento de qualidade

## Histórico de versões

| Versão | Data | Alteração | Responsável |
| :----: | :------: | :-------------------------------------: | :------------------------: |
| 1.0.0 | 08/12/24 | Criação | André Corrêa e Gabriel Mariano |
| 1.0.0 | 09/12/24 | estruturação do documento | André Corrêa |

## 1. Introdução

Esse documento visa apresentar o planejamento de qualidade do projeto, explicando como vai ser acompanhado a qualidade durante o semestre.

## 2. Descrição

O objetivo de ser descrito o planejamento de qualidade é para que, desde de o início do desenvolvimento, seja claro o que é a qualidade de software e como ela é avaliada no contexto do nosso projeto.

Para garantir tal qualidade, optou-se por seguir algumas estratégias, dentre elas destacam-se a criação de padrões (para uma maior coerencia) e coleta de 12 métricas de qualidade, essas que sendo coletadas desde o início mostram a evolução do software.

### Criação de padroẽs

Optou-se por criar padroẽs para que haja sempre uma coerencia interna no projeto, isso que auxilia na evolução e integração com outros serviços.

os padrões vão desde nomes de arquivos até a estrutura de requisições.

### Coleta de métricas

Para avaliar a qualidade de forma mais quantitativa, estão sendo coletadas métricas de qualidade oriundas do [Sonarcloud](https://sonarcloud.io/login), além de outras 4 métricas vindas do estudo de Q-rapids. essas métricas são coletas a cada merge na branch 'DEV'

Para que essas métricas possam ser avaliadas, estão sendo utilizados 2 notebooks Jupyter encontrados no repositório de documentação deste projeto. Esses notebooks geram gráficos temporais das métricas coletadas, o que ajuda a acompanhar o projeto com uma visão holística.

### Validação e verificação

A fim de termos garantia do que está sendo realizado, também há algumas etapas de verificação e validação, essas que sempre são realizadas com o Cliente, buscando sempre a satisfação do mesmo.

A cada história desenvolvida, será realizada uma validação com um formulário externo para encontrar possíveis problemas e elogios.

### Testes de software

Também devem ser desenvolvidos diversos testes automatizados de software, para que seja possivel garantir a estabilidade do mesmo com a evolução do sistema.

Serão desenvolvidos testes unitários que devem cubrir ao menos **90%** do código fonte.

Esse documento vai ser evoluído com o desenvolvimento do projeto e estruturação da equipe.
7 changes: 4 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ nav:
- Sobre: "index.md"
- Guias:
- Guia de Contribuição: "guias/guia_de_contribuicao.md"
- Guia de identidade visual: 'guias/IDV.md'
- Equipe:
- Planejamento de Comunicação: "equipe/planejamento_de_comunicacao.md"
- Gestão de Conhecimentos: "equipe/gestao_de_conhecimentos.md"
Expand Down Expand Up @@ -91,14 +92,14 @@ nav:
# - Visão de Endpoints: 'organizacoes/visao-de-endpoints.md'
# - Manual de Instruções: 'organizacoes/manual_de_instruções.md'
# - Plano de Comunicação: 'planejamento/plano_comunicacao.md'
# - Plano de Qualidade: 'planos/plano_qualidade.md'
# - Plano de Custos: 'planos/planos_custos.md'
- Plano de Qualidade: 'projeto/qualidade.md'
- Plano de Custos: 'projeto/custos.md'
- Plano de Riscos: 'projeto/planejamento_de_risco.md'
# - EVM: 'organizacoes/EVM.md'
# - Analise de Riscos: 'planos/planos_riscos.md'
# - Quadro de Conhecimento e Pareamento: 'planejamento/conhecimento_pareamento.md'
# - Guias:
# - Guia de Contribuição: 'guias/guia-contribuicao.md'
# - Guia de Estilo: 'guias/guia-estilo.md'
# - Código de Conduta: 'guias/codigo-conduta.md'
# - Dojos:
# - Dojo Markdown: 'dojo/dojo-markdown.md'
Expand Down

0 comments on commit d6eafee

Please sign in to comment.