Documento de Ajuda à Elaboração de Relatórios

Nota: Este documento tem por base o disponibilizado pelo Professor Eugénio Oliveira, Professor Catedrático da Faculdade de Engenharia da Universidade do Porto.

ESTRUTURA

1. Objectivos

Descrição sumária do objectivo do trabalho.

2. Motivação

Deve indicar qual o interesse que vê na realização deste trabalho. Pensa que o trabalho só tem um interesse meramente académico ou poderá ser útil como aplicação ou parte de uma aplicação não académica ?
Caso considere que há aplicações práticas interessantes para o trabalho que está a realizar indique-as aqui.

3. Descrição

  Funcionalidades

Descreva aqui o conjunto de tarefas que o programa disponibiliza.

  Estrutura do Programa

Faça uma descrição modular do programa. Indique a divisão em módulos e as correspondentes inter-relações entre os diversos módulos que constituem o programa que realizou.

  Esquemas de Representação de Conhecimento que usou

Descreva os esquemas de Representação de Conhecimento que utilizou no trabalho. Tente, sempre que possível, indicar as vantagens da representação que escolheu em relação a representações alternativas que poderiam ter sido usadas.

  Implementação dos Esquemas de Representação de Conhecimento que usou

Refira nesta sub-secção os detalhes da implementação do programa.

  Análise da complexidade dos algoritmos que usou

Faça aqui uma análise da complexidade dos algoritmos que usou no trabalho.

4. Ambiente de desenvolvimento

Indique aqui as condições gerais de realização do trabalho, indicando: a máquina em que foi realizado, o sistema operativo, o compilador ou ambiente de programação que utilizou, a linguagem em que está escrito o programa, pacotes de "software" extra que tenha utilizado etc.

5. Avaliação do programa

Imagine que tem de escolher um entre vários programas desenvolvidos com o mesmo objectivo do seu trabalho. Que testes realizaria ou que processo de selecção adoptaria para seleccionar o melhor ?

6. Resultados Experimentais

Caso tenha feito simulações coloque nesta secção uma descrição das condições em que foram feitas as simulações e indique os correspondentes resultados obtidos.

7. Melhoramentos

Diga como o programa poderia ser melhorado. Que funcionalidades adicionais deveria ter ou que sofisticações gostaria de ver implementadas caso tivesse tempo para tal. Como poderia aumentar a eficiência do programa, torná-lo mais rápido ou restringir os gastos de memória.

8. Conclusão

Escreva aqui as conclusões que achar devidas.

Bibliografia

Liste aqui a bibliografia que consultou para realização do trabalho.

Apêndices

Manual do utilizador

Coloque aqui uma manual (sucinto) de utilização do seu programa.

Exemplo de uma execução

Apresente aqui uma sequência de "printscreen"s de uma sessão de utilização do seu programa.

Listagem do código

Coloque aqui uma listagem do código que desenvolveu no seu trabalho. Não liste bibliotecas que usou e que não sejam da sua autoria!!.

Nome dos elementos do grupo

---

Aspectos que deve considerar quando escreve um relatório

• Deve ter SEMPRE em consideração quem vai ler o relatório. Que conhecimentos tem o leitor e o que é que o leitor espera encontrar no texto.
• Deve escrever um texto claro e sucinto, sem ambiguidades.
• Todas as afirmações que fizer devem ser fundamentadas.
• Se usa uma terminologia, ou alguns termos, que o leitor não conhece (se são definidos por si ou são gíria de outras áreas) deve defini-los antes de os usar.
• As frases que usa devem ser afirmativas.
• Qualquer trabalho deve ter associado uma avaliação OBJECTIVA que permita estabelecer o seu sucesso.
• Estruturar de modo claro a descrição do seu trabalho. Descrever as funcionalidades do sistema que está a desenvolver. Descrever a estrutura do programa que implementa as funcionalidades que referiu através da sua divisão em módulos sempre que seja o caso. Descrever os esquemas de Representação de Conhecimento diferenciando as definições conceptuais dos aspectos de implementação. Faça uma análise da complexidade dos algoritmos que usar.
• Caso tenha feito opções deve fazer uma pequena resenha das alternativas e justificar a opção tomada indicando as suas vantagens em relação aos competidores.
• Sempre que usar termos ou definições que não sejam suas deve efectuar uma referência bibliográfica para o autor da definição

Aspectos que pode considerar quando escreve um relatório

• Na secção "Melhoramentos" pode fazer afirmações que não sejam fundamentadas uma vez que está a referir trabalho que não está realizado.

Aspectos que NÃO DEVE referir num relatório

• Motivações pessoais. Ex: "este trabalho é bom porque vou aprender Prolog"
• Frases que não pode fundamentar. Ex: "vou usar a Representação de Conhecimento mais adequada e os algoritmos mais eficientes."
• Frases que exprimam falta de confiança ou ambiguidade. EX: "talvez seja possível ...."
• Não misture numa mesma lista aspectos diversos do trabalho tais como funcionalidades, estrutura do programa, detalhes de implementação etc..
• Não refira o plano de trabalho, sobretudo se vai escrever a sequência óbvia. Ex: 1) familiarização com a linguagem; 2) conceptualização do programa; 3) implementação.