Normas para a elaborao de um relatrio para a disciplina de projecto integrado 3. ano 2.

semestre

Abril de 2004

Instituto Superior de Tecnologias Avanadas

ndice

Introduo ..................................................................................................................................................3 O que um relatrio .................................................................................................................................3 Organizao de um relatrio ....................................................................................................................4 Identificao...............................................................................................................................................4 As 4 questes ............................................................................................................................................5 Informao adicional.................................................................................................................................5 Estrutura.....................................................................................................................................................5 Necessidade de estrutura.........................................................................................................................5 Elementos da estrutura.............................................................................................................................6 Linguagem .................................................................................................................................................7 Algumas normas........................................................................................................................................7

Introduo
Este texto apresenta a forma como se deve elaborar relatrios tcnicos ou cientficos. As ideias sugeridas aqui no so dirigidas para nenhuma situao em particular. Pretende-se sobretudo apresentar algumas das questes mais importantes em torno da escrita de relatrios tcnico/cientficos e dar algumas linhas mestras para orientar na escrita de um texto cientfico.

O que um relatrio
O relatrio o documento atravs do qual um tcnico, engenheiro ou cientista faz o relato da forma como realizou um determinado trabalho. O objectivo comunicar (transmitir) ao leitor a experincia acumulada pelo autor na realizao do trabalho e os resultados que obteve. Os resultados apresentados num relatrio (como em qualquer outro texto cientfico) devem ser verificveis. Esse um aspecto importantssimo e frequentemente esquecido. O que dito num relatrio no verdade por causa de quem o escreve (por muito importante que seja o autor). verdadeiro (cientificamente...) porque foi determinado segundo um mtodo conhecido e descreve um trabalho que (para poder ser verdadeiro) est sujeito ao escrutnio dos pares. Em cincia no h verdades absolutas. A verdade (ou a melhor aproximao que conseguimos dela) conseguida atravs do consenso de todas as pessoas que queiram participar numa discusso. Por isso, um relatrio deve permitir a quem o l reproduzir o trabalho realizado, tal qual ele foi feito pelo autor. S assim se pode provar, por exemplo, se determinado resultado vlido, se foi obtido por mtodos correctos e que no h viciao dos resultados. assim que se garante que o que transmitido cientificamente verdadeiro: qualquer resultado, para ter valor cientfico, deve poder ser reproduzido. Um resultado que s uma pessoa consegue obter no tem qualquer validade cientfica. O tipo de relatrio, a sua estrutura, os objectivos que pretende atingir, tudo isto so aspectos que dependem do tipo de problema que se tentou resolver. Mas, na sua essncia, tudo se resume a:

uma pergunta (o problema) uma resposta (as concluses do relatrio)

Em resumo: Para haver um relatrio, tem que haver uma resposta! O problema e a resposta tm que estar bem claros na cabea de quem est a escrever um relatrio! No vale a pena tentar escrever um relatrio sem se saber muito bem: 1. de onde se partiu 2. onde se chegou. O objectivo final do relatrio , dado um problema, sustentar (isto , provar que verdadeira ou correcta) a resposta que apresentada pelo autor. A utilidade de um relatrio (e, sobretudo, a utilidade de saber escrever bem um relatrio) muitas vezes ignorada pela maioria dos estudantes. O relatrio "aquela coisa" que se tem de entregar ao prof. no final do trabalho, e que mais um papel para encher. Mas a realidade bem diferente. Em certos momentos da vida profissional de um engenheiro, a forma como um relatrio escrito pode determinar o sucesso ou insucesso de uma carreira.

Organizao de um relatrio Identificao

A identificao indispensvel em qualquer trabalho escrito. Quando um trabalho escrito chega s mos de algum, h necessidade de saber mais alguma coisa do que o seu contedo: quem o escreveu, se o artigo ou relatrio est actualizado, etc.. Num trabalho que no est identificado, no possvel responder a estas questes.

As 4 questes
Para saber qual a informao necessria para identificar um trabalho, pode recorrer-se s quatro perguntas bsicas do jornalismo: quem, o qu, quando e onde. Quem identifica o autor, ou autores, do trabalho. O qu descreve o que foi feito no trabalho: o ttulo. Quando e onde identificam o local e a data onde o trabalho foi efectuado.

Informao adicional
Para alm das 4 questes bsicas, pode haver mais informao necessria para identificar o trabalho. Geralmente, indica-se tambm o mbito em que o trabalho foi efectuado. No caso de um relatrio de um aluno, ser a cadeira em que o trabalho foi feito. No caso de um trabalho realizado numa empresa, poder ser o projecto a que o trabalho est associado. Outra informao que pode aparecer como adicional, no caso de um trabalho ou relatrio escolar, ser o nome do orientador ou professor.

Estrutura
A estrutura aparece devido a dois tipos de necessidades: por um lado, necessrio a quem escreve organizar primeiro as suas ideias. Por outro lado, essa organizao facilita a tarefa a quem est a ler o trabalho.

Necessidade de estrutura
Ao iniciar a escrita de qualquer trabalho, raramente se tem definido o que se vai escrever de uma ponta outra. No se comea a escrever na primeira linha e se continua, sem interrupes, at ltima. Antes disso, necessrio definir primeiro uma estrutura com os tpicos principais. Depois, cada um desses tpicos desenvolvido em mais pormenor. O processo repetido at se obter uma estrutura que permita passar directamente para a escrita do texto. Cada um destes tpicos ento desenvolvido. A estruturao facilita assim a escrita de um trabalho. Um trabalho escrito deve aparecer ao leitor como uma entidade uniforme. Deve-se ter a sensao de que se est a ler um nico texto, e no uma sequncia de textos diferentes. preciso que o

leitor seja conduzido pelo texto do trabalho desde o princpio ao fim. Deve comear a ler na primeira linha e seguir o trabalho at ao fim sem esforo. Para que tal acontea ao longo de vrias pginas, necessria a existncia de uma estrutura. A estrutura , assim, a espinha dorsal do trabalho. aquilo que permite que todo o texto se torne num conjunto uniforme.

Elementos da estrutura
Uma possvel estrutura a seguinte:

Ttulo (O ttulo deve ser o mais descritivo e objectivo) ndice (Todos os trabalhos devem ser precedidos dum ndice geral de assuntos, incluindo
lista de figuras e de tabelas)

Agradecimentos (Sempre que se justifique, devem ser colocados no fim das concluses,
Todo o texto deve ser redigido em estilo impessoal fez-se, realizou-se, etc. e no em plural majesttico (ns fizemos) ou pessoal (eu fiz))

Sumrio/Resumo (O sumrio dever conter de forma sucinta, clara e objectiva, as

questes ou informaes mais importantes tratadas no trabalho. Isto , dever ser uma sntese dos objectivos a atingir, dos mtodos usados, dos resultados obtidos e concluses)

Introduo (A introduo deve ser curta e ter por finalidade i) enquadrar o problema de
forma geral e especfica; ii) dar a conhecer o estado dos conhecimentos sobre a matria; iii) as hipteses que esto subjacentes ao problema e os diferentes tipos de abordagem do problema; iv) os objectivos claros e especficos do trabalho e, eventualmente, o tipo de abordagem que foi seleccionado)

Procedimento (Nesta seco, descreve-se qual a metodologia de trabalho utilizada.

Devem-se descrever sem ambiguidade as aces efectuadas. Descreve como se faz o trabalho, parte de sistemas de informao, base de dados e de programao)

Discusso dos Resultados (Discutir os resultados principais do trabalho. Apresentar

evidncia para cada concluso baseada nos. Tentar explicar os resultados no esperados e

excepes, interpretar e comparar os resultados com outros obtidos por profissionais ou outros estudantes)

Concluses (Embora seja o trmino do trabalho efectuado, ao mesmo tempo o comeo

das novas dvidas, indicaes e aberturas para desenvolvimentos futuros. Apresente uma concluso completa, clara e objectiva)

Bibliografia (Esta a ltima seco de um relatrio. As referncias so colocadas por

ordem alfabtica do autor e numeradas sequencialmente. Os trabalhos so referidos no texto pelo nmero ou pelo autor(es) e data, como por exemplo: Ccio Frada, JJ. (1991). Guia prtico para a elaborao e apresentao de trabalhos cientficos. Edies Microcosmos. Pp: 149)

Anexos (Conjunto de documentao diversa, utilizada para fundamentar o texto do

relatrio. Nos anexos podem estar: listagens de programas, dados obtidos "em bruto", ... Em geral, os anexos contm o que informao complementar ou demasiado extensa para constar do texto do relatrio)

Linguagem
A forma como o texto escrito tambm importante para a qualidade do relatrio. falsa a ideia de que, se um trabalho apresenta bons resultados cientficos ou um trabalho bastante avanado, uma linguagem correcta desnecessria. A linguagem utilizada deve ser precisa e exacta. As frases utilizadas devem ser curtas. Deve-se evitar a utilizao da voz passiva, e escrever as frases na voz activa.

Algumas normas

Evitar mencionar problemas de tempo (ou falta dele...), de equipamento ou outros de natureza idntica;

Nos trabalhos que envolvam "software", apresentar documentao de alto nvel (no esquecer que h mais modos de representar um programa em alto nvel para alm do fluxograma);

Nos trabalhos que envolvam montagens de "hardware", apresentar esquemas dos circuitos utilizados, que descrevem a lgica do funcionamento do circuito e a sua estrutura (no confundir com esquemas de ligaes, que so um auxiliar de montagem);

Apresentar o cdigo do programa convenientemente detalhado, quer ao nvel da instruo, quer ao nvel dos blocos do programa (o uso de comentrios correctamente colocados pode tornar um programa muito mais fcil de ler)

Utilizar tipos de letras distintos para o texto de programa e para o cdigo. Reservar para o cdigo um tipo de letra de largura constante (courier, por exemplo) e em tamanho que permita a sua leitura fcil (por ex., tamanho 9 para o tipo courier).