Pular para conteúdo

Recomendações para entrega dos trabalhos

Orientações gerais

Os trabalhos devem ser documentados em um arquivo README.md na raiz do repositório do grupo. Se o template já contiver um arquivos com este nome, ele deverá ser substituido. As entregas não serão aceitas fora do GitHub por qualquer outra forma (e-mail, etc.). Entregas realizadas fora do prazo poderão não ser consideradas ou não receberem a nota máxima da atividade.

Orientações para o desenvolvimento

  • Os commits devem ser feitos pelos próprios contribuidores no repositório da entrega, demonstrando que o trabalho foi colaborativo;
  • Testar cada versão antes de fazer commit, principalmente as versões finais;
  • Incluir comentários no código e instruções claras de como executar cada parte do trabalho.

Orientações para a escrita

A escrita do relatório deve seguir o estilo acadêmico técnico-científico. Não usar 1ª pessoa (nem no singular, nem no plural). Numerar e referenciar tabelas e figuras. Dê preferência para sentenças curtas (até 25 palavras) e parágrafos com não mais de 8 linhas. A edição do relatório pressupõe a busca e o estudo de livros e outros materiais referendados de interesse. Usar referências bibliográficas no padrão ABNT[^1]. Revisar o texto antes da entrega para retirar possíveis erros de grafia, concordância e pontuação.

Seções do documento

O relatório deve seguir o seguinte formato:

  • Apresentação do grupo: listar RA, nome e @conta do GitHub de todos os membros;
  • Introdução: apresentar o objetivo do trabalho e a abordagem escolhida pelo grupo;
  • Requisitos: listar o que precisa ser instalado para testar o código;
  • Procedimentos: listar as instruções necessárias para executar o trabalho;
  • Considerações: relatar decisões tomadas, limitações, problemas encontrados, etc.;
  • Referências: listar as referências usadas, preferencialmente com link para acesso.