Merge pull request #153 from fga-eps-mds/docs/final-documentation

docs: adding the finals documentations

.github/ISSUE_TEMPLATE/template-de-bug-report.md

@@ -0,0 +1,36 @@
+---
+name: Bug Report
+about: Reporte um bug
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+### Descrição
+<!--- Descrição geral do problema -->
+
+## Comportamento Atual
+<!--- O que o bug faz no sistema? use texto, imagens e/ou vídeos -->
+
+## Comportamento Esperado
+<!--- Como o sistema deveria reagir se o problema não existisse? use texto, imagens e/ou vídeos -->
+
+## Possível Solução
+<!--- Ideias ou sugestões de solução, caso existam, senão comentar essa seção -->
+
+## Passos para Reproduzir
+<!--- passa a passo, com comandos, para reproduzir o bug -->
+1.
+2.
+3.
+4.
+
+## Contexto
+<!--- descrever o ambiente onde ocorreu o erro, a máquina, o browser, tipo de usuário -->
+<!--- ou qualquer outra variável que seja determinante para reproduzir o erro -->
+### Máquina
+
+### Browser
+
+### Tipo de Usuário

.github/ISSUE_TEMPLATE/template-de-historia-de-usuario.md

@@ -0,0 +1,41 @@
+<!--- No título da issue>
+<!---Nomear História de Usuário-->
+<!---Ex: -->
+<!--- [US-XX] Nome da História de Usuário -->
+
+## História do usuário - Supervisor valida aluno no centro produtivo
+
+### Descrição
+<!--- Descrição da história -->
+Eu, como [Persona], desejo [Tarefa a ser realizada] para que [Finalidade] .
+
+<!--- Descrição da tarefa -->
+
+### Pré-requisitos
+<!--- Qual funcionalidade (Sequenciador) deve ser feito antes -->
+
+<!--- Ex -->
+<!--- CRUD Usuário -->
+
+- 
+
+### Microsserviço
+- [Nome do Microsserviço](link do repositório do microsserviço)
+
+### Tarefas:
+<!--- Descrever a tecnologia e as tarefas correspondentes a história -->
+
+<!---Ex: -->
+
+<!---1. [frontend] Tela de botão de exclusão -->
+
+1. []
+2. []
+
+### Critérios de Aceitação
+- [ ] 
+- [ ] 
+
+### Protótipo
+
+`![Imagem do protótipo]()` ou `![Link do protótipo]()`

.github/ISSUE_TEMPLATE/user-story.md

@@ -0,0 +1,52 @@
+---
+name: 'User Story '
+about: 'Crie uma história de usuário '
+title: ''
+labels: US
+assignees: ''
+
+---
+
+<!--- No título da issue>
+<!---Nomear História de Usuário-->
+<!---Ex: -->
+<!--- [US-XX] Nome da História de Usuário -->
+
+## História do usuário - Supervisor valida aluno no centro produtivo
+
+### Descrição
+<!--- Descrição da história -->
+Eu, como [Persona], desejo [Tarefa a ser realizada] para que [Finalidade] .
+
+<!--- Descrição da tarefa -->
+
+### Pré-requisitos
+<!--- Qual funcionalidade (Sequenciador) deve ser feito antes -->
+
+<!--- Ex -->
+<!--- CRUD Usuário -->
+
+- 
+
+### Microsserviço
+- [Nome do Microsserviço](link do repositório do microsserviço)
+
+### Tarefas:
+<!--- Descrever a tecnologia e as tarefas correspondentes a história -->
+
+<!---Ex: -->
+
+<!---1. [frontend] Tela de botão de exclusão -->
+
+1. []
+2. []
+
+### Critérios de Aceitação
+- [ ] 
+- [ ] 
+
+### Protótipo
+
+`![Imagem do protótipo]()`
+ou
+`![Link do protótipo]()`

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 EPS/MDS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docs/encerramento/relatorio.md

@@ -0,0 +1,73 @@
+# Relatório de Encerramento
+
+## Histórico de versões
+
+| Versão | Data       | Descrição             | Autores     |
+| ------ | ---------- | --------------------- | ----------- |
+| 1.0    | 11/09/2024 | Abertura do documento | [Sebastián Zuzunaga](https://github.com/sebazac332) |
+
+## Introdução
+Neste documento de encerramento será feita uma análise do que planejou a equipe e o que foi realizado durante o desenvolvimento do projeto. Alguns aspectos que serão vistos são: backlog, custo, qualidade e riscos. Esta análise servirá para ilustrar a perspectiva inicial da equipe e o que foi efetivamente concluído ao longo da execução do projeto e guia para futuros desenvolvedores do projeto fornecendo insights sobre o planejamento e execução da solução apresentada.
+
+## Backlog
+### Planejado
+#### MVP
+- [US01] Criar perfil de usuário
+- [US02] Editar informações pessoais
+- [US03] Cadastrar, visualizar, editar e apagar perfis de idosos
+- [US04] Cadastrar medicamentos e alimentos no perfil do idoso
+- [US05] Cadastrar, visualizar, editar e apagar tarefas da rotina do idoso
+- [US06] Cadastrar, visualizar, editar e apagar métricas de um idoso
+
+#### Incremento
+- [US07] Criar, visualizar, editar e apagar postagens no fórum
+- [US08] Tutorial explicativo das funcionalidades do aplicativo
+- [US09] Moderção das publicações do fórum
+
+#### Executadas e Aceitas pelo Cliente
+
+## Custo
+
+<iframe src="https://docs.google.com/spreadsheets/d/1AfbnaR35DlNhQVRTdZQjuMkAz1KyYZplQHarhOnHLr0/pubhtml?widget=true&amp;headers=false"width="100%" width= "100" height="500" frameborder="1" scrolling="no"></iframe>
+
+## Qualidade
+
+Com o objetivo de manter a qualidade do código do trabalho, foram realizados diversos testes, cada um deles garantindo o correto funcionamento de um componente do trabalho. Foi estabelecido como objetivo (...)
+
+## Riscos
+
+### Riscos planejados
+
+#### Externo
+
+- Integrante com problema de saúde
+- Indisponibilidade do cliente	
+- Falha de equipamento	
+
+#### Gerencial
+
+- Saída de algum integrante do projeto	
+- Falta de participação de algum integrante do projeto	
+- Falta de integração da equipe
+- Alteração no escopo do projeto
+- Falta de disponibilização de releases para o cliente testar
+- Falta de participação durante as reuniões
+- Sobrecarga de membros da equipe	
+
+#### Organizacional
+
+- Divergência nos horários disponíveis dos integrantes	
+- Dependência entre atividades	
+
+#### Técnico
+
+- Dificuldade com as tecnologias definidas	
+- Problemas com a infraestrutura de rede
+- Dificuldade na adaptação a novas ferramentas	
+
+### Riscos Enfrentados
+
+- Dificuldade da equipe com novas tecnologias, resultando em uma participação mais ativa no frontend
+- Alteração no escopo do projeto
+- Sobrecarga de membros da equipe	
+- Falta de integração da equipe

docs/planejamento/padroes_da_comunidade.md

@@ -0,0 +1,19 @@
+# Padrões da comunidade
+
+Os padrões da comunidade do github compreende uma lista básica de documentações que auxiliam os contribuidores
+a participarem do projeto de forma mais uniforme. Esse projeto utiliza os principais guias listados abaixo:
+
+- **Description:** Descrição do repositório que auxilia na rápida identificação da função do mesmo.
+- **README:** Arquivo resumo que funciona como apresentação e guia dos pontos chave do projeto, como:
+"problema/solução" e instruções de execução do projeto. [Confira](https://github.com/fga-eps-mds/2024-1-GEROcuidado-Doc/blob/main/README.md).
+- **Code of Conduct:** O [código de conduta](https://github.com/fga-eps-mds/2024-1-GEROcuidado-Doc/blob/main/docs/gestaoDoProjeto/codigo_de_conduta.md) é um documento que serve como um guia ético de comportamento no projeto por parte dos contribuidores.
+- **Contribuiting:** é um [guia](https://github.com/fga-eps-mds/2024-1-GEROcuidado-Doc/blob/main/docs/gestaoDoProjeto/guia_contribuicao.md) de contribuição na visão de desenvolvimento.
+- **License:** dispõe da [licença](https://github.com/fga-eps-mds/2024-1-GEROcuidado-Doc/blob/docs/final-documentation/LICENSE) de réplica e uso do software contido no repositório.
+- **Issue templates:** apresenta os padrões de montagem das [issues](https://github.com/fga-eps-mds/2024-1-GEROcuidado-Doc/blob/main/.github/ISSUE_TEMPLATE/default_issue_template.md)
+- **Pull request template:** apresenta o padrão de preenchimento de um [pull request](https://github.com/fga-eps-mds/2024-1-GEROcuidado-Doc/blob/main/.github/pull_request_template.md) ou *merge request*.
+- **Bug reports:** apresenta o padrão de documento de [bug report](https://github.com/fga-eps-mds/2023-2-GEROcuidado-Doc/blob/main/.github/ISSUE_TEMPLATE/template-de-bug-report.md)
+- **Labels:** As labels são ferramentas de organização e categorização usadas em repositórios para ajudar a gerenciar tarefas, problemas (issues), pull requests (solicitações de pull) e outras atividades relacionadas ao desenvolvimento de software. Elas são pequenos rótulos coloridos que podem ser atribuídos a itens específicos em um repositório para fornecer informações adicionais sobre o status, prioridade, tipo ou qualquer outra característica relevante do item. Além disso elas servem para agrupar essas diferentes tarefas em grupos, o que facilita a pesquisa de alguma tarefa por meio de uma label.
+
+| Versão | Data       | Descrição | Autores |
+| ------ | ---------- | --------- | ------- |
+| 1.0    | 11/09/2024 | Abertura do documento | Gustavo Abrantes |

docs/planejamento/quadro_de_conhecimentos.md

@@ -7,6 +7,7 @@
 | 06/04/2024 |  1.0   | Criação do documento | [Sebastian Zuzunaga](https://github.com/sebazac332) |
 | 07/04/2024 |  1.1   | Tabela de conhecimento | [Gustavo Abrantes ](https://github.com/GustaaSZ)  |
 | 27/07/2024 |  1.2   | Tabela de conhecimento | [Marcella Anderle ](https://github.com/marcellaanderle)  |
+| 27/07/2024 |  1.3   | Tabela de conhecimento | [Jessica Luiza ](https://github.com/Jkluiza)  |
 
 O quadro de conhecimento tem a função de monitorar a evolução do conhecimento dos integrantes de MDS e MPS com respeito às tecnologias utilizadas no projeto, sua implementação começa na semana 2 e é atualizado cada Sprint.
 
@@ -55,3 +56,30 @@ O quadro da semana 2 servirá para ver com que tecnologias já estão familiariz
 
 <iframe width="2000" height="500" frameborder="0" scrolling="yes" src="https://docs.google.com/spreadsheets/d/1kMXA2-AnbGmW9cHn5BuRvYgftUQBVeB3J6M1IS4noyk/edit?gid=1960919248#gid=1960919248"></iframe>
 
+## Quadro de Conhecimento da Sprint 2:
+
+<iframe width="2000" height="500" frameborder="0" scrolling="yes" src="https://docs.google.com/spreadsheets/d/1kMXA2-AnbGmW9cHn5BuRvYgftUQBVeB3J6M1IS4noyk/edit?gid=984880336#gid=984880336"></iframe>
+
+## Quadro de Conhecimento da Sprint 3:
+
+<iframe width="2000" height="500" frameborder="0" scrolling="yes" src="https://docs.google.com/spreadsheets/d/1kMXA2-AnbGmW9cHn5BuRvYgftUQBVeB3J6M1IS4noyk/edit?gid=1692675319#gid=1692675319"></iframe>
+
+## Quadro de Conhecimento da Sprint 4:
+
+<iframe width="2000" height="500" frameborder="0" scrolling="yes" src="https://docs.google.com/spreadsheets/d/1kMXA2-AnbGmW9cHn5BuRvYgftUQBVeB3J6M1IS4noyk/edit?gid=572010832#gid=572010832"></iframe>
+
+## Quadro de Conhecimento da Sprint 5:
+
+<iframe width="2000" height="500" frameborder="0" scrolling="yes" src="https://docs.google.com/spreadsheets/d/1kMXA2-AnbGmW9cHn5BuRvYgftUQBVeB3J6M1IS4noyk/edit?gid=609138643#gid=609138643"></iframe>
+
+## Quadro de Conhecimento da Sprint 6:
+
+<iframe width="2000" height="500" frameborder="0" scrolling="yes" src="https://docs.google.com/spreadsheets/d/1kMXA2-AnbGmW9cHn5BuRvYgftUQBVeB3J6M1IS4noyk/edit?gid=2062062493#gid=2062062493"></iframe>
+
+## Quadro de Conhecimento da Sprint 7:
+
+<iframe width="2000" height="500" frameborder="0" scrolling="yes" src="https://docs.google.com/spreadsheets/d/1kMXA2-AnbGmW9cHn5BuRvYgftUQBVeB3J6M1IS4noyk/edit?gid=1138540408#gid=1138540408"></iframe>
+
+## Quadro de Conhecimento da Sprint 8:
+
+<iframe width="2000" height="500" frameborder="0" scrolling="yes" src="https://docs.google.com/spreadsheets/d/1kMXA2-AnbGmW9cHn5BuRvYgftUQBVeB3J6M1IS4noyk/edit?gid=1446092272#gid=1446092272"></iframe>

mkdocs.yml

@@ -48,6 +48,7 @@ nav:
     - Plano de Qualidade: planejamento/plano_de_qualidade.md
     - Plano de Comunicação: planejamento/plano_de_comunicacao.md
     - Metodologias: planejamento/metodologia.md
+    - Padrões da Comunidade: planejamento/padroes_da_comunidade.md
   - Gestão do Projeto:
     - Protótipo: produto/prototipo/prototipo.md
     - Backlog: gestaoDoProjeto/backlog.md
@@ -86,6 +87,8 @@ nav:
       - Reunião Geral 24/07: semanas/semana_6/reuniao_geral_24_07.md
       - Planning: sprints/sprint_1/planning.md
       - Review: sprints/sprint_1/review.md
+  - Encerramento:
+    - Relatorio de encerramento do projeto: encerramento/relatorio.md
 
 
 plugins: