(#19): adicao de atas e padronizacao do mkdocs

ResidenciaTICBrisa · Mar 11, 2024 · a6791f5 · a6791f5
1 parent 375e491
commit a6791f5
Show file tree

Hide file tree

Showing 12 changed files with 291 additions and 108 deletions.
diff --git a/docs/atas/ata01.md b/docs/atas/ata01.md
@@ -0,0 +1,57 @@
+PROJETO BRISA – LAPPIS/FGA/UNB. 
+REFORMULAÇÃO DO SITE DA REVISTA DARCY
+
+# Ata da Reunião 1 
+- **Data**: 29 de março de 2024
+- **Horário:** 10h00
+- **Local:** Microsoft Teams
+
+## 1. Participantes da Equipe TIC Brisa
+
+- Jefferson Sena: Product Owner
+- José André: Scrum Master
+- Tiago Albuquerque: Dev Team
+- Joselito Prado: Dev Team
+- Luís Filipe: Dev Team
+
+## 2. Participantes da Revista Darcy
+
+- Vanessa: Editora-Chefe da Revista Darcy
+
+## 3. Objetivos da Reunião
+
+1. Apresentação da Equipe.
+2. Visão geral do projeto.
+3. Kick-off.
+
+## 4. Tópicos Discutidos
+
+1. Prazos e cronograma.
+2. Metodologias que vão ser utilizadas.
+3. Compreensão inicial do problema.
+4. Discussão inicial de todos os parâmetros.
+
+## 5. Decisões Tomadas
+
+1. Ter uma reunião entre a equipe TIC BRISA com os designers, editores e apoio de TI da SECOM.
+2. Elaborar um cronograma de trabalho inicial.
+3. Iniciar o levantamento de requisitos com o PBB.
+4. Definição da dinâmica entre equipe-cliente.
+
+## 6. Gravação da Reunião
+[Clique Aqui (Dísponível apenas para pessoas em UnB.br).](https://unbbr.sharepoint.com/:v:/s/BRISA-RevistaDarcy/EQXD0NyUTyFBiEbvEFyYVcMBGWTlZMl61eIlwGHvpEhLVQ?e=OQU3df&nav=eyJyZWZlcnJhbEluZm8iOnsicmVmZXJyYWxBcHAiOiJTdHJlYW1XZWJBcHAiLCJyZWZlcnJhbFZpZXciOiJTaGFyZURpYWxvZy1MaW5rIiwicmVmZXJyYWxBcHBQbGF0Zm9ybSI6IldlYiIsInJlZmVycmFsTW9kZSI6InZpZXcifX0%3D)
+
+## 7. Próxima Reunião
+
+- **Data:** 07 de março de 2024.
+- **Horário:** 10h00.
+- **Objetivo:** Apresentação inicial do PBB; Integração da Equipe com os membros da SECOM.
+
+## 8. Responsáveis pela Ata
+| Autor | Descrição | Revisor | Data |
+| ----- | --------- | ---- | ----- |
+| [José André ](https://github.com/joseandre25)  | Criação da Ata | Vanessa | 11/03/2024 |
+
+
+
+
diff --git a/docs/atas/ata02.md b/docs/atas/ata02.md
@@ -0,0 +1,61 @@
+PROJETO BRISA – LAPPIS/FGA/UNB. 
+REFORMULAÇÃO DO SITE DA REVISTA DARCY
+
+# Ata da Reunião 2 
+- **Data**: 07 de março de 2024
+- **Horário:** 10h00
+- **Local:** Microsoft Teams
+
+## 1. Participantes da Equipe TIC Brisa
+
+- Jefferson Sena: Product Owner
+- José André: Scrum Master
+- Tiago Albuquerque: Dev Team
+- Joselito Prado: Dev Team
+- Luís Filipe: Dev Team
+
+## 2. Participantes da Revista Darcy
+
+- Vanessa: Editora-Chefe da Revista Darcy
+- Danilo Xavier: TI da SECOM
+- Matheus Luis Rosa: TI da SECOM
+- Francisco George Lopes: Editor de Design da Revista Darcy
+
+## 3. Objetivos da Reunião
+
+1. Apresentação das equipes Secom e Brisa. 
+2. Diálogo sobre visão geral do produto e do projeto. 
+3. Apresentação da Metodologia de Trabalho.
+
+## 4. Tópicos Discutidos
+
+1. Apresentação da Equipe da SECOM e da TIC BRISA.
+2. Apresentamos nosso site de documentação e o PBB inicial através do Miro.
+3. Editores da Revista discorreram sobre alguns problemas da atual plataforma de divulgação de conteúdo (Joomla).
+4. Os técnicos de TI da Secom compartilharam informações sobre o Padrão Digital de Governo para sites, disponível no endereço: <https://www.gov.br/ds/home>. 
+5. Discutimos o modelo de usabilidade do governo (eMAG) e sua aplicabilidade no projeto.
+
+## 5. Decisões Tomadas
+
+1. SECOM irá fazer uma reunião interna para validar o PBB bruto e fazer colaborações, além de trazer na próxima reunião referências de templates.
+2. Iremos elaborar um formulário para captar dados do público geral sobre a visão e expectativa do produto. Esse formulário será refinado e validado pela SECOM.
+3. Equipe BRISA se comprometeu em trazer referências externas.
+4. Equipe de T.I da SECOM se comprometeu em trazer as diretrizes técnicas para entendermos como funciona o processo de implantação no .GOV e no UnB.br.
+
+## 6. Gravação da Reunião
+[Clique Aqui (Dísponível apenas para pessoas em UnB.br).](https://unbbr.sharepoint.com/:v:/s/BRISA-RevistaDarcy/ESL9D1ATgGxJjg4QPh3FnUMBbqDNSYhuOfceH8uO-a5Diw?e=naRymG&nav=eyJyZWZlcnJhbEluZm8iOnsicmVmZXJyYWxBcHAiOiJTdHJlYW1XZWJBcHAiLCJyZWZlcnJhbFZpZXciOiJTaGFyZURpYWxvZy1MaW5rIiwicmVmZXJyYWxBcHBQbGF0Zm9ybSI6IldlYiIsInJlZmVycmFsTW9kZSI6InZpZXcifX0%3D)
+
+## 7. Próxima Reunião
+
+- **Data:** 14 de março de 2024.
+- **Horário:** 10h00.
+- **Objetivo:** Validação e Evolução do PBB; Novos encaminhamentos.
+
+## 8. Responsáveis pela Ata
+| Autor | Descrição | Revisor | Data |
+| ----- | --------- | ---- | ----- |
+| [José André ](https://github.com/joseandre25)  | Criação da Ata | Vanessa | 11/03/2024 |
+
+
+
+
diff --git a/docs/politicas/branches.md b/docs/politicas/branches.md
@@ -1,22 +1,12 @@
 ---
 tag: "politicas"
 ---
-Padronização das branches no projeto. 
 
-## Histórico de Versões
-
-
-| Data       | Versão | Descrição                                 | Autor             |
-| :--------: | :----: | :----------:                              | :---------------: |
-| 04/03/2024 |  0.1   | Criação da política de branch             | [Joselito Prado](https://github.com/joselitoprado)
-
-
-
-## Padronização das Branches
+## 1. Padronização das Branches
 A padronização de branches no GitHub é crucial para o desenvolvimento eficiente de software, proporcionando vantagens fundamentais na organização e colaboração. Essa prática aprimora significativamente a qualidade do código-fonte, contribuindo para o sucesso do projeto.
 Como esse projeto de migração do site da Revista Darcy será realizada em WordPress, o time decidiu por manter apenas a main branch. Dessa forma, opções de padronização de branches não serão aplciados a esse projeto, como prefixos.
 
-### Formato:
+### 1.1 Formato
 ```
 #número da issue/assunto
 ```
@@ -27,11 +17,18 @@ Exemplo:
 #87/novo-menu
 ```
 
-### Branch:
+### 1.2 Branch
+
+- **Branch main:** Branch que contém o código mais consolidado existente na aplicação. Nenhum integrante dos times é autorizado a fazer commits diretamente na *main*, o que é garantido através da rule criada no GitHub.
+
+## 3. Histórico de Versões
 
-- **Branch main:** Branch que contém o código em nível de produção, será o código mais consolidado existente na aplicação. Nenhum integrante dos times é autorizado a fazer commits diretamente na *main.*
+| Versão | Autor | Descrição | Revisor | Data |
+| -------| ----- | --------- | ---- | ----- |
+| 1.0    | [Joselito Prado](https://github.com/joselitopradomarques) | Criação da política de branch | [José André](https://github.com/joseandre25)| 04/03/2024 |
+| 1.1    | [José André](https://github.com/joseandre25) | Padronização de Tópicos | [Joselito Prado](https://github.com/joselitopradomarques) | 11/03/2024 |
 
-## Referências
+## 4. Referências
 
 DULCETTI, Bruno. Padrões e nomenclaturas no Git. *BrunoDulcetti*. Disponível em: <https://www.brunodulcetti.com/padroes-e-nomenclaturas-no-git/>. Acesso em: 04 de março de 2024.
 

diff --git a/docs/politicas/commit.md b/docs/politicas/commit.md
@@ -1,41 +1,37 @@
 ---
 tag: "politicas"
 ---
-Padronização dos commits no projeto.
 
-## Histórico de Versões
+## 1. Padronização dos Commits
 
+Os commits devem seguir o padrão descrito a seguir.
 
-| Data       | Versão | Descrição                      | Autor             |
-| :--------: | :----: | :----------:                   | :---------------: |
-| 04/03/2024 |  0.1   | Criação da política de commits | [Joselito Prado](https://github.com/joselitopradomarques)|
-
-## Semântica do Commit
-
-Os commits devem seguir o seguinte padrão:
-
-### Princípios:
-
-#### Commits atômicos
+### 1.1 Commits atômicos
 Sempre dividir em pequenos e significativos commits, fazendo com que cada commit tenha apenas uma funcionalidade.
 
-#### Commits em português
+### 1.2 Commits em português
 Por ser um projeto voltado totalmente para um público brasileiro e por toda equipe ter mais afinidade com o português, foi decidido que todos os commits serão em pt-BR.
 
-### Formato:
+## 2. Formato
 ```
 (#número da issue): assunto
 ```
 
-#### Assunto:
+### 2.1 Assunto
 
 - Deve possuir no máximo 50 caracteres
 
 *Exemplo de commit:*
 ```
 git commit -m "(#02): botão na página inicial"
 ```
+## 3. Histórico de Versões
+
+| Versão | Autor | Descrição | Revisor | Data |
+| -------| ----- | --------- | ---- | ----- |
+| 1.0    | [Joselito Prado](https://github.com/joselitopradomarques) | Criação da política de commits | [José André](https://github.com/joseandre25)| 04/03/2024 |
+| 1.1    | [José André](https://github.com/joseandre25) | Padronização de Tópicos | [Joselito Prado](https://github.com/joselitopradomarques) | 11/03/2024 |
 
-## Referências
+## 4. Referências
 
 DARTORA, João. Tudo o que você precisa saber sobre commits semânticos. *Ilegra*. Disponível em: <https://ilegra.com/blog/tudo-o-que-voce-precisa-saber-sobre-commits-semanticos/>. Acesso em: 04 de março de 2024.
diff --git a/docs/politicas/conduta.md b/docs/politicas/conduta.md
@@ -2,47 +2,48 @@
 tag: "politicas"
 ---
 
-## Histórico de versões
-
-| Data       | Versão | Descrição                      | Autor |
-| :--------: | :----: | :----------------------------: | :-------: |
-| 04/03/2024 |  0.1   |     Abertura do documento      | [Joselito Prado](https://github.com/joselitopradomarques) |
-
-## Propósito
+## 1. Propósito
 
 Residentes do projeto de imersão TIC Brisa Lappis administram o projeto. Com o objetivo de promover um ambiente inclusivo e acolhedor, os residentes comprometem-se a envolver-se ativamente na execução do projeto e na comunidade, garantindo uma experiência isenta de qualquer forma de assédio para todos os participantes, tanto como colaboradores quanto como responsáveis pelo projeto.
 
-## Comportamento
+## 2. Comportamento
 
-### Para estimular aceitáveis
+### 2.1 Atitudes aceitáveis
 
 - Reconhecimento e apreciação de diversas opiniões, perspectivas e vivências.
 - Estímulo à prática de críticas construtivas, tanto ao oferecer quanto ao receber feedback.
 - Assunção de responsabilidade por eventuais equívocos, buscando aprendizado com as experiências.
 - Emprego de linguagem acolhedora e inclusiva.
 - Expressão de empatia em relação aos membros da comunidade.
 
-### Para evitar comportamentos inaceitáveis
+### 2.2 Atitudes inaceitáveis
 
-- Compromisso de não utilizar linguagem ou imagens com conotação sexual.
-- Evitar comportamentos provocativos, insultuosos, depreciativos, bem como ataques pessoais ou políticos.
-- Condenar o assédio, seja ele público ou privado.
-- Respeitar a privacidade, não compartilhando informações pessoais de terceiros sem sua devida autorização, como fotos ou endereços de e-mail.
-- Abster-se de qualquer outra conduta que, dentro dos limites da razoabilidade, possa ser considerada inadequada em um ambiente profissional.
+- Uso de linguagem ou imagens com conotação sexual.
+- Comportamentos provocativos, insultuosos, depreciativos, ataques pessoais ou políticos.
+- Assédio, seja público ou privado.
+- Violação da privacidade, incluindo o compartilhamento não autorizado de informações pessoais de terceiros, como fotos ou endereços de e-mail.
+- Qualquer outra conduta que, dentro dos limites da razoabilidade, possa ser considerada inadequada em um ambiente profissional.
 
-## Responsabilidades
+
+## 3. Responsabilidades
 
 Os mantenedores do projeto têm a responsabilidade de esclarecer os padrões de conduta estabelecidos no código. Em caso de dúvida, é incumbência deles tomar medidas corretivas justas em resposta a quaisquer comportamentos inaceitáveis. Eles também possuem o direito e a responsabilidade de editar, remover ou rejeitar comentários, confirmações, código e outras contribuições que não estejam em conformidade com este Código de Conduta. Além disso, devem comunicar aos responsáveis pela residência caso qualquer colaborador demonstre comportamentos considerados inadequados, ameaçadores, ofensivos ou prejudiciais.
 
-## Escopo
+## 4. Escopo
 
 Este Código de Conduta se aplica tanto dentro do âmbito do projeto quanto em locais públicos onde um indivíduo represente o projeto ou sua comunidade. Isso inclui situações como o uso do repositório oficial relacionado ao projeto ou a participação em reuniões onde atue como representante.
 
-## Execução
+## 5. Execução
+
+Situações de comportamento inadequado podem ser relatadas entrando em contato com os monitores da residência. Todos os relatos serão minuciosamente avaliados e investigados, com a subsequente implementação de uma resposta apropriada para a circunstância. A equipe do projeto é comprometida com a preservação da confidencialidade em relação ao denunciante de um incidente.
 
-Situações de comportamento inadequado podem ser relatadas entrando em contato com [email protected]. Todos os relatos serão minuciosamente avaliados e investigados, com a subsequente implementação de uma resposta apropriada para a circunstância. A equipe do projeto é comprometida com a preservação da confidencialidade em relação ao denunciante de um incidente.
+## 6. Histórico de Versões
 
+| Versão | Autor | Descrição | Revisor | Data |
+| -------| ----- | --------- | ---- | ----- |
+| 1.0    | [Joselito Prado](https://github.com/joselitopradomarques) | Abertura do Documento | [José André](https://github.com/joseandre25)| 04/03/2024 |
+| 1.1    | [José André](https://github.com/joseandre25) | Padronização de Tópicos | [Joselito Prado](https://github.com/joselitopradomarques) | 11/03/2024 |
 
-## Referência
+## 7. Referência
 
-ORGANIZATION FOR ETHICAL SOURCE. Contributor Covenant, 2014. Latest Version. Disponível em: https://www.contributor-covenant.org/version/2/1/code_of_conduct/. Acesso em: 04 de março de 2024.
+ORGANIZATION FOR ETHICAL SOURCE. Contributor Covenant, 2014. Latest Version. Disponível em: <https://www.contributor-covenant.org/version/2/1/code_of_conduct/>. Acesso em: 04 de março de 2024.
diff --git a/docs/politicas/plano-de-comunicacao.md b/docs/politicas/plano-de-comunicacao.md
@@ -1,10 +1,6 @@
 ---
-excerpt: ""
+tag: "politicas"
 ---
-| Data       | Versão | Descrição                      | Autor             |
-| :--------: | :----: | :----------:                   | :---------------: |
-| 04/03/2024 |  0.1   | Criação do documento | [Joselito Prado](https://github.com/joselitopradomarques)|
-
 
 ## 1. Objetivo
 O propósito deste documento é formalizar os canais de comunicação entre os membros do projeto, delineando desde as ferramentas empregadas até os procedimentos essenciais para garantir a adequada armazenagem, organização e distribuição das informações.
@@ -21,6 +17,7 @@ O propósito deste documento é formalizar os canais de comunicação entre os m
 
 
 ## 3. Diretrizes e procedimentos usados para comunicar
+
 ### 3.1 Comunicação Geral
 
 A **comunicação** é a chave principal para o bom progresso do projeto. Tendo isso em vista, é importante zelar pela clareza nas interações. Portanto, os pontos cruciais a serem levados como pilares são:
@@ -30,23 +27,26 @@ A **comunicação** é a chave principal para o bom progresso do projeto. Tendo
 
 
 ### 3.2 Gerência de Reuniões
-#### 3.2.1 Pré-planejamento da Sprint
-
-Num encontro semanal, todos os membros se reúnem para decidir, coletivamente, as atividades e funcionalidades a serem realizadas pelos integrantes, alinhando-se com as disponibilidades e o calendário de todos.
 
-Além disso, são avaliadas as melhorias que devem ser implementadas e o esforço necessário para executar cada tarefa.
+#### 3.2.1 Planejamento da Sprint
 
-#### 3.2.2 Planejamento da Sprint
-Após o pré-planejamento, todos integrantes dividem as que ficarão alocadas  entre os membros de acordo com dificuldade e disponibilidade. Além disso também são levantadas quais melhorias podem ser feitas.
+Num encontro semanal, todos os membros se reúnem para decidir, coletivamente, as atividades e funcionalidades a serem realizadas pelos integrantes, alinhando-se com as disponibilidades e o calendário de todos. Após, todos integrantes dividem as que ficarão alocadas  entre os membros de acordo com dificuldade e disponibilidade. Além disso também são levantadas quais melhorias podem ser feitas.
 
-#### 3.2.3 Reuniões Semanais
-Tarefa realizada pelo discord d, onde cada integrante explica de forma clara: o que foi feito desde a última reunião e o que pretende fazer até a próxima, dessa forma os integrantes estão se mantendo informados do andamento da sprint.
+#### 3.2.2 Daily
+Tarefa realizada pelo discord, onde cada integrante explica de forma clara: o que foi feito desde a última reunião e o que pretende fazer até a próxima, dessa forma os integrantes estão se mantendo informados do andamento da sprint.
 
-#### 3.2.4 Sprint Review
+#### 3.2.3 Sprint Review
 Reunião para mostrar os resultados positivos da sprint, cada membro mostra o trabalho que fez para que o time possa fornecer e obter feedback. 
 
-## 4. Referências
+## 4. Histórico de Versões
+
+| Versão | Autor | Descrição | Revisor | Data |
+| -------| ----- | --------- | ---- | ----- |
+| 1.0    | [Joselito Prado](https://github.com/joselitopradomarques) | Criação da política de commits | [José André](https://github.com/joseandre25)| 04/03/2024 |
+| 1.1    | [José André](https://github.com/joseandre25) | Padronização de Tópicos | [Joselito Prado](https://github.com/joselitopradomarques) | 11/03/2024 |
+
+## 5. Referências
 
 IEEE (2012), IEEE Guide--Adoption of the Project Management Institute (PMI) Standard A Guide to the Project Management Body of Knowledge (PMBOK Guide)--Fifth Edition.
 
-FELIPE, Caio; FREITAS, Gesiel; BUSCHE, João Paulo; CARVALHO, Vinícius; PINHEIRO, Vinicius. SIGS - Plano de Gerenciamento de Comunicação. Disponível em: https://github.com/fga-eps-mds/2017.1-SIGS/wiki/Plano-de-Gerenciamento-de-Comunica%C3%A7%C3%A3o#32-gerencia-de-reuni%C3%B5es. Acesso em: 04 de março de 2024.
+FELIPE, Caio; FREITAS, Gesiel; BUSCHE, João Paulo; CARVALHO, Vinícius; PINHEIRO, Vinicius. SIGS - Plano de Gerenciamento de Comunicação. Disponível em: <https://github.com/fga-eps-mds/2017.1-SIGS/wiki/Plano-de-Gerenciamento-de-Comunica%C3%A7%C3%A3o#32-gerencia-de-reuni%C3%B5es>. Acesso em: 04 de março de 2024.