Padronização do projeto
Introdução
Usando as linguagens de marcação Markdown e HTML na qual estamos utilizando ao longo de toda a documentação do projeto faremos um documento para guardar alguns templates para ajudar na padronização colaborando para a ordem do projeto, trazendo otimização de tarefas e aumento na produtividade.
Componentes
Teremos alguns componentes e seus acompanhamentos que serão padronizados pela equipe.
Tópicos: Títulos e Subtítulos.
Os títulos do projeto definem o nome do documento no mkdocs, assim sendo importante definir nomes significativo para os arquivos criados
Os subtitulos são definidos para informar os tópicos do documento sendo de importancia defini-los de maneira correta para evitar erros de interpretação.
Estruturas:
Nome do título
Nome do Subtítulo
Legendas de Figuras/Tabelas/Etc
As legendas seguirão a seguinte estrutura:
Tabela X ou Figura X : Descrição breve. (Fonte: Fulano de Tal, 2023).
Histórico de versão: estrutura, versionamento, autores, revisores e datas.
Fornece informações sobre o versionamento do documento como a versão, a data que foi versionado, a descrição, o autor, o revisor e a data de revisão.
- Estrutura:
| Versão | Descrição | Autor | Data | Revisor | Data de revisão |
|---|---|---|---|---|---|
| 1.0 | Descrição sobre o versionamento | Nome Autor | dd/mm/yyyy | Nome Revisor | dd/mm/yyyy |
Referência Bibliográfica: estrutura, citação, citação de autor, data e link
Usada para trazer embasamento ao texto escrito, trazendo assim um detalhamento da fonte na qual surgiu a inspiração para escrever um determinado texto.
Estrutura:
[1] Quem escreveu o artigo, Título do artigo, Disponível em: , Acesso em dd de Mês de yyyy.
Bibliografia: estrutura, nome site, data e link
Usado para apoio da documentação, contendo link para ferramentas, sites utilizados, etc
[1] "Nome do site", Disponivel em: [link ddo site], acesso em 04 de Outubro de 2023
Imagens: tag, link referênciado, padrão, legendas.
As imagens contidas nesse documento são para esclarecer visualmente algumas ideias abordadas e trazer uma interpretação visual sobre um dado assunto. Usando a tag em html de img, trazemos o link dá imagem que deve estar no repositório do GitHub.
Estrutura:
<img src = "link da imagem" width = tamanhopx>'
Cronograma: tabelas
O cronograma traz detalhadamente todo o planejamento e execução do grupo:
| Tarefa | Período de Desenvolvimento | Atribuição | Período de Revisão | Revisor |
|---|---|---|---|---|
| tarefa | Início: dd/mm Fim: dd/mm |
pessoa01 | Início: dd/mm Fim: dd/mm |
pessoa02 |
Estrutura do projetos: nome do arquivo, estrutura.
Aqui temos a estruturação do arquivo que iremos trabalhar:
Estrutura:
- Cada pasta representa uma parte da entrega da disciplina, e deve ser escrita com letra minúscula e sem acentuação (Ex: planejamento/)
- Caso haja espaço entre palavras, use hífen como separação (Ex: analise-de-requisitos/)
- A pasta "assets" guarda as imagens referentes às entregas
Guias Github
Aqui teremos alguns guias e padronizações da nossa ferramenta de versionamento Github, trazendo versões da documentação para a plataforma, assim todos podem contribuir de maneira rápida e correta.
Issues: estrutura
Issues são feitas para designar tarefas feitas em reuniões para o github, servindo de guia para a resolução de tarefas e questões. A estrutura seguirá o seguinte modelo:
Descrição
- Atributos do projeto
Prazo
- Entrega : dd/mm
- Revisão : dd/mm
Pull Request: estrutura, quando fazer, como fazer.
As pull request servem para solicitar a junção da branch criada com a principal (main), também usado como mecanismo de revisão de código, sendo feito pelo revisor atribuído àquela determinada tarefa. Os pull requests seguirão o seguinte modelo:
## Descrição
- Relate o que foi alterado em tópicos
### Número da Issue: defina aqui a issue da branch a ser merjada com a main.
Padronização de commit: estrutura, padrões, mensagem.
A padronização de commit é importante para a identificação de commit's feitos durante o processo de desenvolimento do projeto. Segundo o padrão Conventional Commits5 de maneira adaptada ao projeto, os commits seguirão o seguinte modelo:
- docs: para novas alterações na documentação
- fix: para correções de erros na documentação
- refactor: para correções que não corrigem erros, nem adicionam nada novo, apenas melhoram a estrutura do código
Referencias Bibliograficas
[1] Raphael Pires, Qual a importância da padronização de documentos?, Disponível em: https://rockcontent.com/br/blog/padronizacao-de-documentos/, Acesso em : 06 de Outubro de 2023.
[2] Awari Code, Versionamento de código: entenda o que é e porque é importante, Disponível em: https://awari.com.br/versionamento-de-codigo/?utm_source=blog&utm_campaign=projeto+blog&utm_medium=Versionamento%20de%20c%C3%B3digo:%20entenda%20o%20que%20%C3%A9%20e%20porque%20%C3%A9%20importante#:~:text=Ou%20seja,%20o%20Github%20funciona,%C3%A9%20igual%20ao%20do%20Git., Acesso em : 06 de Outubro de 2023.
[3] Even3, Referência bibliográfica: como fazer e qual a sua importância, Discponível em: https://blog.even3.com.br/referencia-bibliografica-como-fazer-e-qual-a-sua-importancia/, Acesso em : 07 de Outubro de 2023
[4] Daniela Diana, Bibliografia, Disponível em: https://www.todamateria.com.br/bibliografia/, Acesso em: 07 de Outrubro de 2023
[5] Conentional Commits, Disponível em: https://www.conventionalcommits.org/en/about/, Acesso em: 29 de Outrubro de 2023
Histórico de Versões
| Versão | Descrição | Autor | Data | Revisor | Data de revisão |
|---|---|---|---|---|---|
| 1.0 | Criando guia de contribuição | Doan Filho | 22/10/2023 | Caio Braga | 28/10/2023 |
| 1.1 | Refatoraçaõ da interface | Caio Braga | 28/10/2023 | Doan Filho | 29/10/2023 |
| 1.2 | Adicional referência bibliográfica para commits | Caio Braga | 29/10/2023 | Doan Filho | 29/10/2023 |