Relatórios
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 funcinalidades que referiu referindo
a sua divisão em módulos sempre que seja o caso. Descrever
as Estruturas de Dados diferenciando
as definições conceptuais dos aspectos de
implementação. Detalhes de implementação só
devem ser referidos se forem essenciais para o funcionamento do
sistema ou essenciais para melhorar a eficiência do seu programa. Caso
decida incluir pormenores de implementação coloque-os numa
secção separada.
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
seus 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 Java"
-
Frases que não pode fundamentar. Ex: "vou usar a Estrutura de Dados 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.