From c067c2835eeb033ea50d9ca09f78ba69914dc99a Mon Sep 17 00:00:00 2001 From: Gustavo Abrantes Date: Wed, 11 Sep 2024 17:18:44 -0300 Subject: [PATCH 1/4] docs: adding the project license --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..434c06f --- /dev/null +++ b/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. \ No newline at end of file From 250012d825079015932868ee1f66f9afde3a6220 Mon Sep 17 00:00:00 2001 From: Gustavo Abrantes Date: Wed, 11 Sep 2024 18:09:21 -0300 Subject: [PATCH 2/4] docs: adding some documentations --- .../ISSUE_TEMPLATE/template-de-bug-report.md | 36 +++++++++++++ .../template-de-historia-de-usuario.md | 41 +++++++++++++++ .github/ISSUE_TEMPLATE/user-story.md | 52 +++++++++++++++++++ docs/planejamento/padroes_da_comunidade.md | 19 +++++++ mkdocs.yml | 1 + 5 files changed, 149 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/template-de-bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/template-de-historia-de-usuario.md create mode 100644 .github/ISSUE_TEMPLATE/user-story.md create mode 100644 docs/planejamento/padroes_da_comunidade.md diff --git a/.github/ISSUE_TEMPLATE/template-de-bug-report.md b/.github/ISSUE_TEMPLATE/template-de-bug-report.md new file mode 100644 index 0000000..382a49e --- /dev/null +++ b/.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 + + +## Comportamento Atual + + +## Comportamento Esperado + + +## Possível Solução + + +## Passos para Reproduzir + +1. +2. +3. +4. + +## Contexto + + +### Máquina + +### Browser + +### Tipo de Usuário \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/template-de-historia-de-usuario.md b/.github/ISSUE_TEMPLATE/template-de-historia-de-usuario.md new file mode 100644 index 0000000..f81f8cd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/template-de-historia-de-usuario.md @@ -0,0 +1,41 @@ + + + + +## História do usuário - Supervisor valida aluno no centro produtivo + +### Descrição + +Eu, como [Persona], desejo [Tarefa a ser realizada] para que [Finalidade] . + + + +### Pré-requisitos + + + + + +- + +### Microsserviço +- [Nome do Microsserviço](link do repositório do microsserviço) + +### Tarefas: + + + + + + +1. [] +2. [] + +### Critérios de Aceitação +- [ ] +- [ ] + +### Protótipo + +`![Imagem do protótipo]()` ou `![Link do protótipo]()` \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/user-story.md b/.github/ISSUE_TEMPLATE/user-story.md new file mode 100644 index 0000000..d43fc06 --- /dev/null +++ b/.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: '' + +--- + + + + + +## História do usuário - Supervisor valida aluno no centro produtivo + +### Descrição + +Eu, como [Persona], desejo [Tarefa a ser realizada] para que [Finalidade] . + + + +### Pré-requisitos + + + + + +- + +### Microsserviço +- [Nome do Microsserviço](link do repositório do microsserviço) + +### Tarefas: + + + + + + +1. [] +2. [] + +### Critérios de Aceitação +- [ ] +- [ ] + +### Protótipo + +`![Imagem do protótipo]()` +ou +`![Link do protótipo]()` \ No newline at end of file diff --git a/docs/planejamento/padroes_da_comunidade.md b/docs/planejamento/padroes_da_comunidade.md new file mode 100644 index 0000000..fd33392 --- /dev/null +++ b/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 | \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index b1618d5..4e0f21d 100644 --- a/mkdocs.yml +++ b/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 From 449bb15d3c199c20734d16278c5bb351d5826bb1 Mon Sep 17 00:00:00 2001 From: Jkluiza Date: Wed, 11 Sep 2024 18:49:51 -0300 Subject: [PATCH 3/4] docs: updating the knowledge framework --- docs/planejamento/quadro_de_conhecimentos.md | 28 ++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/planejamento/quadro_de_conhecimentos.md b/docs/planejamento/quadro_de_conhecimentos.md index 4cfba7e..3baec55 100644 --- a/docs/planejamento/quadro_de_conhecimentos.md +++ b/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 +## Quadro de Conhecimento da Sprint 2: + + + +## Quadro de Conhecimento da Sprint 3: + + + +## Quadro de Conhecimento da Sprint 4: + + + +## Quadro de Conhecimento da Sprint 5: + + + +## Quadro de Conhecimento da Sprint 6: + + + +## Quadro de Conhecimento da Sprint 7: + + + +## Quadro de Conhecimento da Sprint 8: + + \ No newline at end of file From c636cbf5ae37b61eb3ddd34789c6cc88d9756869 Mon Sep 17 00:00:00 2001 From: Sebastian Zuzunaga Date: Wed, 11 Sep 2024 21:51:08 -0500 Subject: [PATCH 4/4] docs: created closing report --- docs/encerramento/relatorio.md | 73 ++++++++++++++++++++++++++++++++++ mkdocs.yml | 2 + 2 files changed, 75 insertions(+) create mode 100644 docs/encerramento/relatorio.md diff --git a/docs/encerramento/relatorio.md b/docs/encerramento/relatorio.md new file mode 100644 index 0000000..61fa49b --- /dev/null +++ b/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 + + + +## 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 diff --git a/mkdocs.yml b/mkdocs.yml index b1618d5..74e8c36 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -86,6 +86,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: