Departamento de Ciência de Computadores, Faculdade de Ciências da Universidade do Porto

← voltar a página principal

Elaboração do relatório final

Os alunos deverão entregar um relatório final do seu trabalho mediante um formulário de entrega no Moodle (a disponibilizar).

O relatório deve descrever de forma rigorosa e detalhada as actividades efectuadas pelo aluno na empresa ou instituição de acolhimento. Espera-se uma descrição concisa, clara, direta e bem organizada do trabalho efetuado. Ao invés, não deve ser a colecção de toda a informação recolhida, a listagem completa dos programas desenvolvidos, nem um manual de utilização.

Dão-se a seguir orientações que devem ser consideradas pelos alunos e seus orientadores no que toca ao conteúdo e forma do relatório, bem como de complementos opcionais ao relatório.

Conteúdo

O relatório, escrito em português ou inglês, deverá conter as seguinte estrutura:

• Capa: contendo informação referente ao título do trabalho, autor, e data;
• Introdução: introdução ao tema e descrição dos seus objectivos;
• Enquadramento/Estado da Arte: enquadramento do trabalho em termos do estado da tarde de índole científica (ex. artigos científicos) e/ou técnica (ex. ferramentas utilizadas), contendo a informação base necessária à compreensão da descrição do trabalho;
• Descrição do trabalho: dividida em sub-secções, apresentando a abordagem ao trabalho, a sua implementação, e resultados obtidos;
• Conclusão: análise crítica apresentando as principais conclusões, discussão de aspetos que poderiam ser considerados em trabalho futuro;
• Bibliografia: referências bibliográficas ou outras;
• Apêndice (opcional): figuras/listagens/tabelas complementares, ou outros elementos considerados relevantes .

Regras de formatação

Os alunos devem seguir as seguintes regras de formatação:

• O documento deve ter o formato PDF e ter no máximo 16 páginas A4 excluindo capa, bibliografia e apêndices, e com tamanho de letra 11pt,
• Páginas, secções, figuras, tabelas e listagens de código devem ser numeradas.
• Figuras, tabelas e listagens devem ser referidas no texto do documento.

Complementos opcionais ao relatório

Vídeo de demonstração

Muitos dos trabalhos desenvolvidos resultam em software cujo funcionamento pode ser demonstrado. Os alunos são por isso encorajados a produzir uma demonstração em vídeo. Por exemplo, o vídeo pode incluir capturas de écran e/ou câmara, textos sobrepostos sobre imagem ara destacar pontos importantes da demonstração, áudio , etc. O demonstração não substitui a descrição do trabalho no relatório mas pode complementá-la e contribuir para uma melhor avaliação do trabalho desenvolvido.

O vídeo deve:

• ter uma duração máxima de 5 minutos
• ser colocado numa plataforma de distribuição de vídeo digital, por exemplo YouTube ou Vimeo; e
• ter o seu URL mencionado no relatório logo na introdução.

Repositórios de código com licença “open-source” (projectos c/orientação DCC)

Especialmente para projetos (com orientação de docentes do DCC) em que é desenvolvido software que possa interessar à comunidade científica, será interessante partilhar o código desenvolvido com uma licença “open-source” num repositório de código, desde que haja permissão do orientador para tal.

Nesse caso, o repositório de código deve:

• ser colocado numa plataforma como GitHub, GitLab, ou BitBucket;
• ter o seu URL mencionado no relatório logo na introdução;
• conter um ficheiro README.md com instruções de compilação e uso; e
• conter um ficheiro LICENSE.txt com a licença “open-source” aplicável, por exemplo GPLv3 ou outra adequada - para referência consulte https://choosealicense.com/.

No caso de estágios, esta opção é naturalmente mais restrita por questões de propriedade intelectual. Os alunos devem ter o cuidado de não publicar código que viole a propriedade intelectual da instituição de acolhimento em qualquer repositório público, a não ser que haja uma política da instituição nesse sentido e autorização para o trabalho em causa.