Fazer uma relação de pontos interessantes para se documentar

[HenrryEsposito]

A intenção inicial do nosso projeto é gerar uma documentação geral dos repositórios do projeto SOS-RS, dessa forma podemos contribuir com o projeto base que fizemos o fork, pois eles ainda não possuem nenhum tipo de documentação, e conhecer mais profundamente esse code base que queremos evoluir.

De antemão, acreditamos que uma documentação do back-end se resumirá a documentar seus endpoints e estruturas de dados, como é de costume de repositórios back-end, mas a documentação do front-end varia de caso para caso.

Nessa demanda você deve rodar e testar o projeto na totalidade e explorar o code base do front em busca de pontos importantes para se documentar. Procure aprender sobre o code base e pense que você deve tomar nota de cada ponto importante de se explicar sobre ele para o próximo desenvolvedor que for estudar sobre esse projeto.

Esse estudo vai gerar as próximas demandas de documentação do nosso projeto.

Critérios de aceite:

• Gerar uma lista de pontos importantes para documentarmos sobre o front-end do SOS-RS.
• Adicione essa lista na pasta ./docs do repositório. (Se ela ainda não existe, deve criá-la)