Organização de pastas

Estrutura de pastas

Manter um padrão de pastas em projetos é essencial para garantir que todos os membros da equipe consigam acessar e compreender a estrutura da documentação de maneira rápida e eficiente.

Para isso, é necessário estabelecer alguns padrões para que diferentes times estejam alinhados em uma mesma forma de estruturar sua documentação. A imagem abaixo representa como deve ser organizada a documentação do seu time.

Fonte: Própria

Explicacao Para a aimagem acima

• Pasta assets contém arquivos gerais e é raramente utilizada.
• Pasta docs apresenta todos os arquivos referentes à documentação do projeto.
• Pasta docs/assets armazena arquivos genéricos utilizados nas páginas em Markdown (.md), como imagens, GIFs, etc.
• Pasta docs/assets/estrutura contém arquivos genéricos sobre estrutura.
• Pasta docs/assets/eletronica-energia contém arquivos genéricos relacionados a eletrônica/energia.
• Pasta docs/assets/software contém arquivos genéricos relacionados a software.

• Pasta docs/assets/geral contém arquivos genéricos relacionados a coisas gerais do projeto.

• Pastas docs/estruturas, docs/eletronica-energia e docs/software representam o corpo principal da documentação dos times. Nelas, são encontrados todos os elementos referentes à documentação, com ênfase em arquivos Markdown (.md), que funcionam como um arquivo de texto estruturado para uma melhor visualização.

• Além disso, é importante que TODOS os times criem pastas para organizar melhor os conteúdos dos arquivos, conforme ilustrado na figura abaixo:

Fonte: Própria

• Pasta docs/geral contém componentes principais sobre aspectos gerais do projeto, sendo criada e organizada por todos os times.

Tabela de versionamento

Versão	Data	Descrição	Responsável
1.0	28/10/2024	Criação do documento de organização de Pastas	Arthur José