Como organizar arquivos de um projeto

Como organizar arquivos de um projeto

Objetivo

Construir uma estrutura de projeto previsível e portátil.

Conceitos essenciais

Separação por função

src, tests, docs, data, assets e scripts comunicam intenção e reduzem mistura de responsabilidades.

README

Um README deve explicar objetivo, requisitos e como executar o projeto.

Configuração

Arquivos de exemplo como .env.example documentam configuração sem publicar segredos.

Nomes e portabilidade

Diferenças de case sensitivity e caracteres especiais podem causar problemas entre ambientes. Use convenções consistentes.

Gerados versus fonte

Diretórios como build, dist, caches e dependências instaladas podem ser regeneráveis e nem sempre devem ser versionados.

Modelo mental

PROJETO → src | tests | docs | data | assets | scripts | README

Exemplo e demonstração

Estrutura-base do FT-001.

ft001-workspace/
├── src/
├── tests/
├── docs/
├── data/
├── assets/
├── scripts/
├── README.md
├── .gitignore
└── .env.example

Experimento / prática

• Crie a estrutura ft001-workspace sem dados sensíveis.
• Escreva no README uma frase explicando cada diretório.

Erros comuns

• Usar caminhos absolutos da sua máquina dentro do código sem necessidade.
• Misturar arquivos gerados e fonte sem documentação.

Resumo

Ao concluir esta aula, revise o modelo mental e tente explicá-lo com suas próprias palavras antes de avançar.