Reorganização da Estrutura da Documentação
1. Histórico de versão
| Versão | Data | Descrição | Autor |
|---|---|---|---|
| 0.1 | 21/02/2022 | Criação do documento | Paulo Victor |
2. Introdução
Quando iniciamos o projeto, não havíamos definido uma estrutura padrão para a documentação do projeto. Tentamos separar por pastas inicialmente, mas esse formato funcionou bem apenas até o ínicio da segunda entrega da disciplina, onde começamos a identificar a dificuldade em dar manutenção e localizar conteúdo da documentação no formato que estava antes. Por causa disso, decidimos atualizar essa estrutura para que a mesma seja mais escalável com as próximas entregas e nos permita com facilidade aprimorar os artefatos já existentes.
3. Como era anteriormente:
Tínhamos uma pasta content que armazenava todos os arquivos de artefatos do projeto. Nesse mesmo nível, existia uma pasta assets que armazenava todas as imagens dos artefatos. Dentro de content, começamos a tentar estruturar os artefatos por tipos, mas isso começou a dificultar a separação do que era relacionado a primeira entrega e o que era relacionado a segunda. Não demorou muito para que essa estrutura começasse a se tornar inviável conforme o projeto foi crescendo.
4. Como está agora:
Primeiro de tudo começamos a separar o conteúdo por entregas. Dessa forma, conseguimos isolar os artefatos relacionados com cada entrega do projeto, facilitando a organização e manutenibilidade.
Para facilitar a localização de artefatos, decidimos separar, dentro de cada pasta de entrega, as pastas por módulo. Assim conseguimos isolar os artefatos dentro de módulos específicos. Também criamos pastas assets para armazenar as imagens e conteúdos relacionados aos artefatos de cada entrega, facilitando assim a localização desses elementos.
Para podermos reutilizar conteúdos que são gerais a todas as entregas, decidimos criar uma pasta global que armazena todos os assets que podem ser utilizados em qualquer entrega.
