Ajustes na padronizacao dos documentos

fga-eps-mds · Apr 10, 2024 · 59895a9 · 59895a9
1 parent 2ffb0a9
commit 59895a9
Show file tree

Hide file tree

Showing 12 changed files with 65 additions and 56 deletions.
diff --git a/docs/atasReuniao/reuniao1.md b/docs/atasReuniao/reuniao1.md
@@ -1,4 +1,5 @@
 # Reunião 1
+
 ## 1. Introdução
 
 Esse documento visa apresentar os dados da primeira reunião realizada entre as equipes. Houve apresentaçãos dos membros e discussão dos primeiros detalhes do projeto.

diff --git a/docs/atasReuniao/reuniao2.md b/docs/atasReuniao/reuniao2.md
@@ -1,9 +1,10 @@
-# Quadro de Conhecimentos
-## Introdução
+# Reunião 2
+
+## 1. Introdução
   No dia 04/04, foi realizado um dojô abortando questões infra e dev do nosso projeto. Falamos sobre as tecnologias docker, git e linux (parte de infra) e fastapi, html/css e angular (dev).
   O link da gravação da reunião pode ser encontrado [aqui]()
 
-## Membros Presentes
+## 2. Membros Presentes
   - Gabriel Roger Amorim da Cruz
   - João Pedro de Camargo Vaz
   - Victor Hugo Oliveira Leão
@@ -23,14 +24,10 @@
 
 [![Reunião 2.2](https://img.youtube.com/vi/rWX1IPWtppw/0.jpg)](https://www.youtube.com/watch?v=rWX1IPWtppw)
 
-Versionamento do documento
+## 4. Versionamento do Documento
+
 | Data | Versão | Descrição | Autor |
 | :-----: | :-------------: | :---------------: | :-: |
-| 08/04/2023 | 1.0 | Versão inicial da reuniao 1 | [João Pedro de Camargo Vaz](github.com/JoaoPedro0803) |
-| 09/04/2023 | 1.1 | Adição das gravações das reuniões| [João Pedro de Camargo Vaz](github.com/JoaoPedro0803) e [Vinícius Assumpção de Araújo](github.com/viniman27) |
-
-
-
-
-
-
+| 08/04/2024 | 1.0 | Versão inicial da reunião 1 | [João Pedro de Camargo Vaz](github.com/JoaoPedro0803) |
+| 09/04/2024 | 1.1 | Adição das gravações das reuniões| [João Pedro de Camargo Vaz](github.com/JoaoPedro0803) e [Vinícius Assumpção de Araújo](github.com/viniman27) |
+| 10/04/2024 | 1.2 | Ajuste na padronização do documento | [Gabriel Roger Amorim da Cruz](https://github.com/GabrielRoger07) |
diff --git a/docs/atasReuniao/reuniao3.md b/docs/atasReuniao/reuniao3.md
@@ -1,4 +1,5 @@
 # Reunião 3
+
 ## 1. Introdução
 
 No dia 08/04 foi realizada uma reunião para apresentar o lean inception para os membros de MDS e o passo a passo para rodar o projeto.

diff --git a/docs/contribuicao/CodigoConduta.md b/docs/contribuicao/CodigoConduta.md
@@ -4,11 +4,11 @@
 
 Esse documento apresenta o código de conduta do projeto. Ele se baseia no [código de conduta do grupo do UnB-TV do semestre 2023.2](https://fga-eps-mds.github.io/2023.2-UnB-TV-DOC/#/./politicas/CODE_OF_CONDUCT), a fim de que o projeto continue tendo similaridades na parte de contribuição.
 
-## 2. Nossa promessa
+## 2. Nossa Promessa
 
 Com o objetivo de fomentar uma comunidade aberta e acolhedora, nós, como colaboradores e administradores deste projeto, comprometemo-nos a fazer a participação deste projeto uma experiência livre de assédio para todos, independentemente da aparência pessoal, deficiência, etnia, gênero, idade, identidade ou expressão de gênero, identidade ou orientação sexual, nacionalidade, nível de experiência, porte físico, raça ou religião.
 
-## 3. Nossos padrões
+## 3. Nossos Padrões
 
 Exemplos de comportamentos que contribuem a criar um ambiente positivo incluem:
 
@@ -26,7 +26,7 @@ Exemplos de comportamentos inaceitáveis por parte dos participantes incluem:
 - Publicar informação pessoal de outros sem permissão explícita, como, por exemplo, um endereço eletrônico ou residencial;
 - Qualquer outra forma de conduta que pode ser razoavelmente considerada inapropriada num ambiente profissional.
 
-## 4. Nossas responsabilidades
+## 4. Nossas Responsabilidades
 
 Os administradores do projeto são responsáveis por esclarecer os padrões de comportamento e é esperado deles que ajam de forma apropriada e justa em resposta a qualquer instância de comportamento inaceitável.
 
@@ -46,8 +46,9 @@ Administradores do projeto que não sigam ou não mantenham o Código de Conduta
 
 Este Código de Conduta é adaptado do [Contributor Covenant](https://www.contributor-covenant.org/), versão 1.4, disponível em [https://www.contributor-covenant.org/pt-br/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/pt-br/version/1/4/code-of-conduct/).
 
-## 8. Versionamento do documento
+## 8. Versionamento do Documento
 
 | Data | Versão | Descrição | Autor |
 | :-----: | :-------------: | :---------------: | :-: |
-| 31/03/2023 | 1.0 | Versão inicial com pontos 1 a 7 | Victor Hugo Oliveira Leão |
+| 31/03/2024 | 1.0 | Versão inicial com pontos 1 a 7 | [Victor Hugo Oliveira Leão](https://github.com/victorleaoo) |
+| 10/04/2024 | 1.1 | Ajuste na padronização do documento | [Gabriel Roger Amorim da Cruz](https://github.com/GabrielRoger07) |
diff --git a/docs/contribuicao/PoliticasContribuicao.md b/docs/contribuicao/PoliticasContribuicao.md
@@ -4,9 +4,9 @@
 
 Esse documento guia como devem ser feitas as contribuições no projeto. Ele se baseia nas [políticas do grupo do UnB-TV do semestre 2023.2](https://fga-eps-mds.github.io/2023.2-UnB-TV-DOC/#/./politicas/CONTRIBUTING), a fim de que o projeto continue tendo similaridades na parte de contribuição.
 
-## 2. Guia de contribuição
+## 2. Guia de Contribuição
 
-### 2.1 Reportar Bugs
+### 2.1. Reportar Bugs
 
 Para reportar um Bug, uma issue deve ser criada seguindo o template abaixo:
 
@@ -26,7 +26,7 @@ Passo a passo detalhado de como o Bug pode ser encontrado/reproduzido
 Adicione comentários adicionais que considerar importante
 ```
 
-### 2.2 Sugerir melhorias
+### 2.2. Sugerir Melhorias
 
 Para sugerir uma melhoria, uma issue deve ser criada seguindo o template abaixo:
 
@@ -46,7 +46,7 @@ Explicar de forma mais detalhada o que deve ser feito para a melhoria ser aprese
 Adicione comentários adicionais que considerar importante
 ```
 
-### 2.3 Branch
+### 2.3. Branch
 
 As novas branchs criadas devem seguir o padrão:
 
@@ -62,7 +62,7 @@ A nome da branch deve ser associado ao número da issue e da tarefa, já que tod
 9-Nome-da-tarefa
 ```
 
-### 2.4 Commit
+### 2.4. Commit
 
 Os commits devem ser atômicos (uma contribuição pequena para resolver um problema específico) e significativos. A mensagem do commit deve conter o que foi feito de maneira sucinta e direta, além disso ela precisa estar em **português**, **começar** com um **verbo** e com a **primeira letra maiúscula**. Exemplo de como um commit deve ser feito:
 
@@ -80,7 +80,7 @@ Co-authored-by: name <name@example.com>
 Co-authored-by: another-name <another-name@example.com>"
 ```
 
-### 2.5 Pull Request
+### 2.5. Pull Request
 
 Ao criar um Pull Request, ele deve seguir o seguinte padrão:
 
@@ -103,8 +103,9 @@ Ao criar um Pull Request, ele deve seguir o seguinte padrão:
 3. Build passando.
 ```
 
-## 3. Versionamento do documento
+## 3. Versionamento do Documento
 
 | Data | Versão | Descrição | Autor |
 | :-----: | :-------------: | :---------------: | :-: |
-| 31/03/2023 | 1.0 | Versão inicial com pontos 1 a 2 (2.5) | Victor Hugo Oliveira Leão |
+| 31/03/2023 | 1.0 | Versão inicial com pontos 1 a 2 (2.5) | [Victor Hugo Oliveira Leão](https://github.com/victorleaoo) |
+| 10/04/2024 | 1.1 | Ajuste na padronização do documento | [Gabriel Roger Amorim da Cruz](https://github.com/GabrielRoger07) |
diff --git a/docs/planejamento/Metodologias.md b/docs/planejamento/Metodologias.md
@@ -6,7 +6,7 @@ Esse documento apresenta as metodologias que serão trabalhadas pela equipe dura
 
 ## 2. Metodologias
 
-### 2.1 Scrum
+### 2.1. Scrum
 
 Scrum é um framework dentro do qual pessoas podem tratar e resolver problemas complexos e adaptativos, enquanto produtiva e criativamente entregam produtos com o mais alto valor possível. Ele se baseia em ciclos curtos chamados sprints.
 
@@ -20,7 +20,7 @@ Dessa forma, as práticas aplicadas do Scrum pela equipe são:
 
 Além disso, o pensamento de metodologia ágil com entregas incrementais constantes irá guiar a equipe durante todo o desenvolvimento.
 
-### 2.2 XP (Extreme Programming)
+### 2.2. XP (Extreme Programming)
 
 A Extreme Programming é uma metodologia de programação desenvolvida com a finalidade de otimizar as rotinas de times de desenvolvimento. O que abre espaço para que cada participante seja capaz de cumprir suas tarefas de um modo eficiente, sem gerar atrasos que possam encarecer o projeto.
 
@@ -30,7 +30,7 @@ Dessa forma, as práticas aplicadas da Extreme Programming pela equipe são:
 2. **Cliente Presente**: O cliente ou representante do cliente está envolvido no processo de desenvolvimento.
 3. **Refatoração**: Processo de analisar um algoritmo pouco legível com a finalidade de simplificá-lo, facilitando a sua leitura. Será reforçado pela equipe.
 
-### 2.3 Kanban
+### 2.3. Kanban
 
 O Kanban é um sistema de organização e administração de projetos que visa controlar fluxos de maneira eficiente. Por ser altamente adaptável à realidade de diferentes negócios, o Kanban é um método amplamente adotado por setores que vão desde logística à desenvolvimento de software.
 
@@ -51,7 +51,7 @@ Para o projeto, o quadro Kanban será feito e visualizado por meio da plataforma
 - **Done**: Tarefas da sprint já concluídas.
 - **Closed**: Para tarefas finalizadas, normalmente de sprints passadas já acabadas.
 
-### 2.4 Lean Inception
+### 2.4. Lean Inception
 
 O Lean Inception é um método de desenvolvimento de projetos ágeis que visa agilizar o processo de entrega do produto, garantindo maior assertividade e qualidade na sua entrega final.
 
@@ -77,8 +77,9 @@ Dessa forma, a equipe aplicou o Lean Inception com o PO, com as seguintes etapas
 
 > Wagner Hörlle: Lean Inception: O que é e como funciona esse método?. Disponível em: https://blog.csptecnologia.com/lean-inception/
 
-## 6. Versionamento do documento
+## 4. Versionamento do Documento
 
 | Data | Versão | Descrição | Autor |
 | :-----: | :-------------: | :---------------: | :-: |
-| 31/03/2023 | 1.0 | Versão inicial com pontos 1 a 3 | Victor Hugo Oliveira Leão |
+| 31/03/2024 | 1.0 | Versão inicial com pontos 1 a 3 | [Victor Hugo Oliveira Leão](https://github.com/victorleaoo) |
+| 10/04/2024 | 1.1 | Ajuste na padronização do documento | [Gabriel Roger Amorim da Cruz](https://github.com/GabrielRoger07) |
diff --git a/docs/planejamento/PlanejamentoTempo.md b/docs/planejamento/PlanejamentoTempo.md
@@ -26,8 +26,8 @@ Esse documento apenas "traduz" o cronograma da equipe para termos da equipe (Spr
 | Semana 16 - 01/07 | Entrega da Release 3 |
 | Semana 17 - 08/07 | Fim da disciplina |
 
-## 3. Versionamento do documento
+## 3. Versionamento do Documento
 
 | Data | Versão | Descrição | Autor |
 | :-----: | :-------------: | :---------------: | :-: |
-| 31/03/2023 | 1.0 | Versão inicial com pontos 1 a 2 | Victor Hugo Oliveira Leão | 
+| 31/03/2024 | 1.0 | Versão inicial com pontos 1 a 2 | [Victor Hugo Oliveira Leão](https://github.com/victorleaoo) | 
diff --git a/docs/planejamento/PlanoComunicacao.md b/docs/planejamento/PlanoComunicacao.md
@@ -42,8 +42,8 @@ As reuniões com o PO (Caio) e o professor (Hilmer) estão, inicialmente, progra
 | WhatsApp | Responsável pela comunicação rápida da equipe interna |
 | Zenhub | Acompanhamento da realização do projeto (quadro Kanban), juntamente com Roadmap |
 
-## 6. Versionamento do documento
+## 6. Versionamento do Documento
 
 | Data | Versão | Descrição | Autor |
 | :-----: | :-------------: | :---------------: | :-: |
-| 31/03/2023 | 1.0 | Versão inicial com pontos 1 a 5 | Victor Hugo Oliveira Leão |
+| 31/03/2024 | 1.0 | Versão inicial com pontos 1 a 5 | [Victor Hugo Oliveira Leão](https://github.com/victorleaoo) |
diff --git a/docs/sprints/SprintTemplate/PareamentoTemplate.md b/docs/sprints/SprintTemplate/PareamentoTemplate.md
@@ -1,24 +1,31 @@
 # Template de Pareamento
 
-## Integrantes do pareamento
+## 1. Integrantes do pareamento
 
 Os integrantes desse pareamento são:
 
 - Nome 1;
 - Nome 2...
 
-## Síntese das reuniões de pareamento
+## 2. Síntese das reuniões de pareamento
 
 Tabela com a síntese de como ocorreu o pareamento:
 
 | Data/Horário | O que foi feito |
 | :----------: | :-------------- |
 | XX/XX/XX HH:HH-HH:HH | Foi feito... |
 
-## Conclusão do pareamento
+## 3. Conclusão do pareamento
 
 Deve ser explicado o que foi esperado e o que foi feito pelos membros do pareamento.
 
-## Comentários do pareamento
+## 4. Comentários do pareamento
 
-Aqui cada integrante do grupo pode apontar pontos positivos e negativos do pareamento, juntamente com sugestões de como ele poderia ser melhor feito, ou destacar o que deve continuar sendo feito para uma boa interação.
+Aqui cada integrante do grupo pode apontar pontos positivos e negativos do pareamento, juntamente com sugestões de como ele poderia ser melhor feito, ou destacar o que deve continuar sendo feito para uma boa interação.
+
+## 5. Versionamento do Documento
+
+| Data | Versão | Descrição | Autor |
+| :-----: | :-------------: | :---------------: | :-: |
+| 31/03/2024 | 1.0 | Versão inicial do documento | [Victor Hugo Oliveira Leão](https://github.com/victorleaoo) |
+| 10/04/2024 | 1.1 | Ajuste na padronização do documento | [Gabriel Roger Amorim da Cruz](https://github.com/GabrielRoger07) |
diff --git a/docs/sprints/SprintTemplate/SprintTemplate.md b/docs/sprints/SprintTemplate/SprintTemplate.md
@@ -1,6 +1,6 @@
 # Template Sprint
 
-## Objetivos
+## 1. Objetivos
 
 Explicar em pontos os objetivos gerais da Sprint para a equipe como um todo:
 
@@ -9,7 +9,7 @@ Explicar em pontos os objetivos gerais da Sprint para a equipe como um todo:
 - Documentos a serem atualizados;
 - Atualizações a serem feitas.
 
-## Planejamento de Reuniões
+## 2. Planejamento de Reuniões
 
 Tabela com o planejamento de reuniões da Sprint:
 
@@ -19,14 +19,21 @@ Tabela com o planejamento de reuniões da Sprint:
 | Dailys | - |
 | Review + Retrospectiva | - |
 
-## Atividades
+## 3. Atividades
 
 Explicar em uma tabela quais as issues serão feitas, o repositório no quais serão trabalhadas e os responsáveis (pareamento):
 
 | Issue | Repositório | Responsáveis |
 | :---: | :---------: | :----------: |
 | Issue X - Nome | Repositório X | Nome dos responsáveis |
 
-## Conclusão da Sprint
+## 4. Conclusão da Sprint
 
-Explicar o que foi esperado e o que foi entregue.
+Explicar o que foi esperado e o que foi entregue.
+
+## 5. Versionamento do Documento
+
+| Data | Versão | Descrição | Autor |
+| :-----: | :-------------: | :---------------: | :-: |
+| 31/03/2024 | 1.0 | Versão inicial do documento | [Victor Hugo Oliveira Leão](https://github.com/victorleaoo) |
+| 10/04/2024 | 1.1 | Ajuste na padronização do documento | [Gabriel Roger Amorim da Cruz](https://github.com/GabrielRoger07) |
diff --git a/docs/treinamentos/QuadroConhecimento.md b/docs/treinamentos/QuadroConhecimento.md
@@ -4,7 +4,7 @@
 
 Esse documento visa apresentar o quadro de conhecimentos da equipe no começo do projeto e será incrementado ao longo do mesmo, a fim de mostrar a evolução da equipe no semestre como um todo. Além de guiar treinamentos a serem realizados pela equipe de EPS para os membros de MDS.
 
-## 2. Quadro de Conhecimentos da equipe
+## 2. Quadro de Conhecimentos da Equipe
 
 Levando em consideração as tecnologias iniciais e básicas do projeto, as seguintes tecnologias foram colocadas para avaliação dos membros:
 
@@ -29,8 +29,8 @@ Dessa forma, pode ser visto abaixo o quadro de conhecimentos resultante da equip
 
 <iframe width="1250px" height="350px" frameborder="0"width="1250px" height="550px" frameborder="0" src="https://docs.google.com/spreadsheets/d/e/2PACX-1vQ72YKtHMCatmYWbDmzqj7Pjemp7-3qArnThDl8VurnmTWBJIdXwWn5xUbOXn0AkxGgQbHzrqcBbAJz/pubhtml?widget=true&amp;headers=false"></iframe>
 
-## 3. Versionamento do documento
+## 3. Versionamento do Documento
 
 | Data | Versão | Descrição | Autor |
 | :-----: | :-------------: | :---------------: | :-: |
-| 01/04/2023 | 1.0 | Versão inicial com pontos 1 a 2 | Victor Hugo Oliveira Leão |
+| 01/04/2024 | 1.0 | Versão inicial com pontos 1 a 2 | [Victor Hugo Oliveira Leão](https://github.com/victorleaoo) |
diff --git a/docs/treinamentos/dojoInicial.md b/docs/treinamentos/dojoInicial.md
@@ -4,14 +4,7 @@
 
 Visando o treinamento e preparação dos alunos da disciplina de Métodos de Desenvolvimento de Software nas tecnologias utilizadas no projeto, foi realizado um treinamento inicial no dia 4 de abril de 2024.
 
-Neste treinamento, foi apresentado brevemente o funcionamento das tecnologias que serão utilizadas no projeto: 
-* Linux
-* Docker
-* Git
-* Html
-* Css
-* Angular
-* FastAPI
+Neste treinamento, foi apresentado brevemente o funcionamento das tecnologias que serão utilizadas no projeto: Linux, Docker, Git, Html, Css, Angular, FastAPI.
 
 ## 2. Gravação do Treinamento