por que eu criei esses templates?

Até um tempo atrás não tinha a mínima ideia do que colocar no ReadMe dos meus repositórios. Após algumas pesquisas, criei um repositório com dois templates para facilitar a estruturação e apresentação de repositórios de projetos e estudos no GitHub.

Criar um repositório bem organizado foi o meio de explicar detalhadamente os objetivos de projetos/estudos e mostrar as ferramentas que utilizei durante o processo de codificação.

qual o objetivo desse repositório?

Desde a visão geral até as instruções para instalação, cada seção foi pensada para fornecer informações de forma organizada e acessível. O objetivo aqui é explicar o que foi feito no repositório e não deixá-lo como se fosse apenas arquivos de códigos que ninguém sabe o que é ou pra que foi feito.

Se você prefere uma abordagem mais seccionada, os templates possuem um sumário que mostra divisões do projeto, permitindo um detalhamento de cada parte, desde a configuração até as funcionalidades principais, versões responsivas de layouts, meios de instalações e tecnologias utilizadas.

Ambos os templates estão disponíveis no meu repositório do GitHub em duas pastas: projetos e estudos.

site explicativo

Indo para além deste repositório, criei uma página web para explicar o porquê devemos documentar e explicar bem o nossos softwares e faço uma relação com documentações de linguagens de programação e outras ferramentas.

Espero que seja útil como tem sido pra mim nos meus repositórios de estudo e projetos pessoais!