Você está na página 1de 13

Guia para a redao de relatrios

Pedro Fonseca pf@ua.pt Departamento de Eletrnica, Telecomunicaes e Informtica Universidade de Aveiro

Introduo
A escrita de Relatrios faz parte integrante da atividade de qualquer profissional na rea tcnica e cientfica, seja ele Engenheiro ou Investigador, quer na sua formao, quer no exerccio da profisso. O presente texto apresenta algumas "deixas" para ajudar na redao de relatrios tcnicos ou cientficos. As ideias e os conceitos sugeridos aqui no so dirigidos a nenhuma situao em particular. Pretende-se, sobretudo, apresentar algumas das questes mais importantes em torno da escrita de relatrios tcnicocientficos e dar algumas linhas mestras para orientar a escrita de um texto cientfico. Juntamente com este texto, divulgado um Modelo de Relatrio (em formato odt e pdf), organizado segundo a estrutura proposta.

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 objetivo comunicar (transmitir) ao leitor e registar para memria futura 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 aspeto importantssimo e frequentemente esquecido. O que dito num relatrio no verdade por causa de quem o escreve (por muito importante que seja o autor). verdade (cientificamente) porque foi determinado segundo um mtodo conhecido e descreve um trabalho que (para poder ser considerado 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 corretos 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. No h um modelo nico para o relatrio. O tipo de relatrio, a sua estrutura, os objetivos que pretende atingir, so aspetos 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) O Relatrio testemunha (isto : relata) o percurso desde a partida (o problema) chegada (a resposta). O seu objetivo final , dado um problema, sustentar (isto , provar que verdadeira ou correta) a resposta que apresentada pelo autor. Essa resposta consta das concluses do Relatrio. Ao escrever um Relatrio (ou qualquer outro texto de ndole tcnico-cientfica), estes dois conceitos devem estar sempre bem presentes na mente do autor: De que ponto partiu? Qual foi o problema que se props resolver? Aonde chegou? Qual a resposta que conseguiu obter? No vale a pena escrever se estas duas questes no estiverem claramente respondidas.
Figura 1: As duas questes fundamentais

/media/truecrypt1/Textos/Didacticos/Guia Redaccao Relatorios/Guia redaccao relatorios.odt, rev 11

Pedro Fonseca Guia para a Redaco de Relatrios

Para qu relatrios?
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. Os relatrios so a forma de deixar registado e de comunicar, por escrito, o trabalho desenvolvido. Em certos momentos da vida profissional de um engenheiro, a forma como um relatrio escrita pode determinar o sucesso ou insucesso de uma carreira. Exagero? Vejamos: A empresa A encomendou empresa B um determinado software. O cdigo continua a pertencer empresa B, que se compromete entregar empresa A apenas o cdigo executvel (o binrio). Aps a entrega, verifica-se que a aplicao no funciona. A empresa A responsabiliza o seu fornecedor pelo facto de o software entregue no cumprir todas as especificaes. A questo no resolvida amigavelmente e segue para tribunal. Em tribunal, a empresa A ter que provar que o produto fornecido pela empresa B no corresponde ao que foi pedido. Como se faz isso? Com um relatrio. Se se pensar que A uma PME, fcil que um projeto volumoso corresponda ao investimento do trabalho de toda a equipa durante 6 meses e que a viabilidade econmica de A dependa desse relatrio.

Caractersticas de um Relatrio
Um Relatrio deve ser: Objetivo: um Relatrio cientfico ou tcnico lida com dados concretos e evidncias suportadas pela realidade. S. Conciso: deve ser to curto quanto possvel, contendo apenas os elementos que so necessrios para cumprir a sua funo. No deve ter elementos apenas para encher: nem texto desnecessrio (a chamada palha), nem dados que no sejam relevantes para o objeto da anlise. Completo: deve conter todos os elementos necessrios compreenso do relato que feito e do trabalho que foi desenvolvido, sem omisses. Conclusivo: no deve deixar dvidas ao Leitor. Todas as questes levantadas no mbito do trabalho desenvolvido tm que ser encerradas. Podem ser encerradas respondendo claramente questo (A corrente que passa atravs de uma resistncia diretamente proporcional tenso que lhe aplicada) ou, quando no haja uma resposta definitiva, devem ser identificados os aspetos a estudar que podero contribuir para que se atinja essa resposta.

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 atualizado, etc. Num trabalho que no est identificado, no possvel responder a estas questes.

/media/truecrypt1/Textos/Didacticos/Guia Redaccao Relatorios/Guia redaccao relatorios.odt, rev 11

Pedro Fonseca Guia para a Redaco de Relatrios

3 Indentifica o autor, ou autores do trabalho. O que foi feito no relatrio. Ttulo

As 5 questes
Para saber qual a informao necessria para identificar um trabalho, pode recorrerse s cinco perguntas bsicas do jornalismo: quem, o qu, quando, onde e porqu. (Estas quatro perguntas so conhecidas na literatura inglesa como os 5 Ws: who, what, when, where, why). As quatro primeiras questes (Quem, O qu/Ttulo, Quando e Onde) so dados curtos que devem estar presentes na capa do Relatrio ou, se no existir capa, na primeira pgina. O Porqu geralmente respondido pelo Resumo do Relatrio.

Quem O qu

Who What

Quando When Onde Porqu

Data e local de realizao do Where trabalho Why Razo de ser do trabalho (porque que o autor realizou o trabalho; porque que o leitor o h-de ler) Figura 2: As 5 questes

Informao adicional
Para alm das 5 questes bsicas, pode haver mais informao necessria para identificar o trabalho. Alguns exemplos de informao complementar so: a instituio onde o trabalho foi realizado (universidade, empresa, ) ou para a qual o trabalho foi realizado (podem no ser a mesma); o mbito em que o trabalho foi efetuado 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 projeto a que o trabalho est associado; o orientador do trabalho ou o responsvel pelo seu enquadramento na instituio (o professor da cadeira, o orientador de estgio ou de doutoramento, ); a instituio que subsidiou ou financiou o trabalho.

Estrutura
A estrutura num texto surge por dois tipos de necessidades: por um lado, necessrio, a quem escreve, organizar as suas ideias antes de escrever. Por outro lado, essa organizao facilita a tarefa a quem est a ler o texto.

Necessidade de estrutura
Ao iniciar a escrita de qualquer texto, raramente se tem definido o que se vai escrever de uma ponta outra. Na preparao de textos tcnicos ou cientficos, 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 que depois so desenvolvidos em mais pormenor. O processo repetido at se obter uma estrutura suficientemente fina que permita passar diretamente para a escrita do texto. A estruturao facilita assim a escrita de um trabalho. Um trabalho escrito deve aparecer ao leitor como uma entidade uniforme. Deve ter-se 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.
/media/truecrypt1/Textos/Didacticos/Guia Redaccao Relatorios/Guia redaccao relatorios.odt, rev 11

Pedro Fonseca Guia para a Redaco de Relatrios

Elementos da estrutura
Uma possvel estrutura, que utilizada no modelo de Relatrio que acompanha este texto, a seguinte (adaptado de [1]): Resumo Introduo Descrio do problema Aparelhagem e equipamento Procedimento Resultados Anlise Concluses Referncias Anexos Esta estrutura especialmente adequada a trabalhos laboratoriais. No caso de trabalhos de conceo e projeto, poder haver algumas alteraes, que so mencionadas mais frente (seco Relatrios de projeto, pg. 7).

Resumo
O Resumo deve descrever sumariamente o trabalho e o relatrio no seu conjunto. Sumaria de forma clara, concisa e completa os contedos do Relatrio, incluindo o problema abordado, a metodologia utilizada, os resultados e as concluses. Deve ser a ltima seco a ser escrita, apenas quando tudo o resto j est terminado. O Resumo um texto que, no devendo exceder dois pargrafos, consegue captar toda a essncia do que transmitido no Relatrio. A deciso de ler ou no um relatrio na sua totalidade muitas vezes decidida com base no Resumo: conforme a impresso com que fica do Resumo, o Leitor vai decidir se vale a pena, ou no, continuar a ler o resto do relatrio. Cabe ao Autor fazer um resumo que cative o Leitor e o leve a interessarse pelo resto do Relatrio. A linguagem utilizada no resumo deve, na medida do possvel, evitar o recurso ao jargo tcnico, de modo a permitir a sua leitura e compreenso por quem no seja especialista da rea.

Introduo
A Introduo faz a apresentao geral do trabalho descrito no Relatrio: qual o problema que se pretende resolver, o seu enquadramento e justificao, a metodologia utilizada. A Introduo d ao Leitor, para alm de uma perspetiva geral sobre o trabalho realizado, o porqu da sua realizao e de que forma esse trabalho se relaciona com o problema que se prope tratar: se se trata de um aspeto particular do problema, se a resposta apresentada de aplicao universal ou se est sujeita a algumas condicionantes, ...

Descrio do problema
Apresenta o problema que se pretende resolver ou atacar. Esta seco define os objetivos do trabalho relatado e nela deve ficar clara para o Leitor, qual a pergunta (o ponto de partida) a que o trabalho pretende dar resposta. Em trabalhos tcnicos e cientficos, a Descrio do Problema complementada com o seu enquadramento, que pode incluir, por exemplo, o Estado da Arte, isto , uma apresentao do conhecimento existente no momento sobre o assunto tratado no texto. Quando aplicvel, pode conter tambm uma anlise das solues potencialmente concorrentes com a analisada no documento, ponderando as suas vantagens e desvantagens. Esta seco detalha, quando necessrio, os aspetos complementares em relao forma como se abordou o
/media/truecrypt1/Textos/Didacticos/Guia Redaccao Relatorios/Guia redaccao relatorios.odt, rev 11

Pedro Fonseca Guia para a Redaco de Relatrios

problema: se se est a estudar um aspeto particular do problema, se a resposta encontrada est dependente de hipteses prvias ou se, pelo contrrio, universal, ...

Aparelhagem e equipamento
Descreve-se a aparelhagem e o equipamento utilizado: que tipo de material, de que maneira foi utilizado, quais as ligaes entre os diversos aparelhos, etc. Em trabalhos de ndole cientfica, esta seco descrever, por exemplo, os instrumentos de medida utilizados e a organizao de toda o equipamento experimental. Em trabalhos de Engenharia, comum esta seco descrever a instalao ou o sistema que foi estudado. Se o problema abordado se relacionar com redes de computadores, descrever-se- aqui qual o tipo de rede utilizada, a sua arquitetura, etc.

Procedimento
Esta seco apresenta a metodologia de trabalho utilizada. Devem-se descrever sem ambiguidade as aes efetuadas, ou seja, como se realizou o trabalho descrito no Relatrio. Nalgumas situaes, a seco Procedimento e a seco Aparelhagem e Equipamento podero ser reunidas numa s, uma vez que ambas tratam de descrever a realizao do trabalho experimental (uma descreve a parte material, a outra a parte procedimental), recebendo, nessa altura, nome de Metodologia ou Mtodos.

Resultados
Apresentam-se aqui os resultados "em bruto" do trabalho. No deve haver qualquer interpretao dos resultados (tirar concluses, dizer se so maus ou bons, atribuir-lhes significados) mas apenas "despejar" (dentro de certos limites) o que se observou. Tal como se disse antes, os resultados apresentados num relatrio devem ser verificveis e o Relatrio deve estar organizado de modo a permitir a sua reproduo.

Anlise dos Resultados


Neste seco, procede-se transformao dos resultados "em bruto", apresentados na seco anterior, de forma a que possam ser utilizados: aplicao de frmulas, extrao de mdias e desvios padres, etc. O objetivo final do relatrio , dado um problema, sustentar (isto , provar que verdadeira ou correta) a resposta que apresentada pelo autor. A Anlise dos Resultado permite obter informao que seja mais facilmente assimilvel pelo leitor. Depois de estruturarmos os dados numa forma que seja conveniente nossa perceo, vamos comear a fazer a sua anlise e, muito especialmente, a sua anlise crtica. O desenvolvimento da fase de anlise dos dados depende do enquadramento em que feito o trabalho de laboratrio. Na investigao cientfica, o trabalho tem geralmente por objetivo demonstrar (servir de suporte de prova a) uma teoria ou hiptese. O tratamento dos dados incidir, por exemplo, na procura das tendncias que relacionam as vrias grandezas em anlise. Em que que o consumo de refrigerantes na populao jovem afeta a sua taxa de obesidade? poder ser uma questo a que se procura dar resposta. Outras vezes, o resultado considerado correto j conhecido: por exemplo, quando queremos verificar a conformidade de determinado equipamento. o caso do controlo de qualidade, em que se realizam testes laboratoriais em que j se conhece o bom resultado e o que se pretende verificar se as caractersticas de determinado equipamento esto ou no conformes a esses resultados considerados bons. Em qualquer caso, o objetivo final sempre o mesmo: verificar a veracidade 1 ou a falsidade de determinada
1 Na verdade, nenhuma experincia consegue provar a veracidade de uma hiptese. A realizao de uma experincia com

/media/truecrypt1/Textos/Didacticos/Guia Redaccao Relatorios/Guia redaccao relatorios.odt, rev 11

Pedro Fonseca Guia para a Redaco de Relatrios

tese, em que essa tese pode ser uma nova teoria cientfica, ou pode ser simplesmente a afirmao que um determinado telemvel aguenta quedas da altura de 1m. Um dos objetivos da anlise crtica validar os resultados obtidos: so coerentes entre si? So coerentes com o esperado? Aparentam estar isentos de erros significativos? Ou, pelo contrrio, so incoerentes? H resultados que esto claramente em contradio com os restantes? A anlise crtica tem a funo de ser advogada e detetive dos dados apresentados. Advogada, quando d fundamento aos resultados, mostrando que tm todas as razes para serem considerados vlidos; detetive quando, ao detetar algo que no est bem, no descansa enquanto no identificar a causa da incoerncia nos dados. Sempre que os dados, por alguma razo, no esto coerentes entre si, necessrio procurar a causa. Essa causa pode ser um erro, o que muitas vezes acontece. Mas pode ser tambm a evidncia de uma falha na hiptese inicial; muitas descobertas cientficas resultaram da identificao de valores, em experincias, que no batiam certo com os restantes. essencial que toda a anlise dos dados seja feita com honestidade. De nada serve tentar tapar o sol com a peneira (ou, como dizia Ea de Queirs, colocar sobre a nudez forte da verdade, o manto difano da fantasia). Os resultados obtidos devem ser apresentados sem adulteraes e as anlises devem ser cruas e objetivas

Concluses
A seco de Concluses encerra a questo que deu origem ao Relatrio. Num trabalho de investigao, darse- resposta ao problema que estava a ser investigado: se a hiptese inicial foi verificada ou no, se a resposta claramente conclusiva ou se os trabalhos fizeram surgir outras questes que necessitam de ser investigadas, No caso de um trabalho de Engenharia, em que houve o desenvolvimento de um circuito ou equipamento, as Concluses avaliam se o projeto cumpriu ou no as especificaes e os requisitos definidos partida. Num trabalho escolar, as Concluses avaliam se os resultados esto de acordo ou no com a teoria que se pretendia demonstrar ou verificar e a contribuio do trabalho para o progresso do aluno. As concluses podem tambm incluir uma sntese da avaliao crtica dos resultados obtidos: se esto de acordo com a teoria, se os erros so elevados, se so credveis.

Referncias
Lista dos artigos, livros e outra bibliografia consultada e que seja mencionada no texto do trabalho ou relatrio. Podem tambm ser includos outros livros e artigos que se debrucem sobre a rea do trabalho, devendo, neste caso, constar de uma lista parte. Deve haver critrio na escolha das referncias a apresentar. Se, por um lado, um nmero muito reduzido de referncias um indicador pouco abonatrio da qualidade do trabalho, tambm igualmente m a incluso de referncias apenas para fazer volume: referncias que em nada contribuem para a compreenso do Relatrio e no esto relacionadas com o trabalho desenvolvido. Incluem-se muitas vezes neste caso referncias aos datasheets dos componentes utilizados, manuais de software ou equipamento, etc., que surgem em muitos relatrios sem qualquer necessidade nem justificao.

Anexos
Conjunto de documentao diversa, utilizada para fundamentar o texto do relatrio. Nos anexos podem estar: esquemas eltricos, documentao de programas, dados, ... Em geral, os anexos contm o que informao complementar ou demasiado extensa para constar do texto do relatrio. Os esquemas eltricos de um circuito, desenhos mecnicos do equipamento ou documentao de software so elementos candidatos a serem apresentados como anexos ao Relatrio. No entanto, s devem ser
resultados de acordo com uma dada teoria no prova a inexistncia de situaes em que essa teoria falha. Ao contrrio, uma nica experincia com um resultado contraditrio com uma teoria suficiente para provar a sua falsidade (para refutar essa teoria).
/media/truecrypt1/Textos/Didacticos/Guia Redaccao Relatorios/Guia redaccao relatorios.odt, rev 11

Pedro Fonseca Guia para a Redaco de Relatrios

anexados se contriburem de alguma forma para a melhor compreenso do Relatrio. No vale a pena acrescentar Anexos s para fazer volume. A utilidade de anexar as impresses (listagens) do cdigo do software tambm bastante discutvel. Outra situao que pode justificar um anexo a existncia de frmulas ou resultados no texto cuja deduo, embora suportada no Corpo do Relatrio, no seja fcil ou evidente. Nessa altura, remete-se essa deduo para os Anexos, sobretudo quando for bastante longa. Pode ocorrer a necessidade de fazer acompanhar o Relatrio de dados originais que sejam bastante extensos. Por exemplo, um estudo sobre uma determinada populao pode ser baseado em estatsticas realizadas a partir de um conjunto vasto de indicadores (sociais, econmicos, ) recolhidos durante um largo perodo. Para alguns leitores, a anlise de alguns dados em detalhe poder ter significado ou importncia, pelo que devero acompanhar o relatrio. Mas a sua introduo no corpo do texto pode torn-lo excessivamente grande e difcil de ler. Nessa altura, o corpo do Relatrio contm apenas os valores mais relevantes, remetendo-se para o anexo todo o detalhe sobre os dados.

Relatrios de projeto
O caso dos relatrios de projeto apresenta algumas diferenas em relao a um relatrio de trabalho laboratorial. Num relatrio de projeto, as questes ligadas conceo de uma soluo assumem grande importncia, sendo trabalhos onde, em geral, h uma grande liberdade criativa. O Relatrio assume assim o papel, no s de dar conta do estado final atingido pelo projeto, mas tambm de dar conhecimento ao leitor do processo de conceo e das principais opes tomadas no decurso desse trabalho. No caso particular dos relatrios de projeto, deve-se ter em conta um conjunto de aspetos, de entre os quais se destacam: apresentar a lgica utilizada na conceo da soluo desenvolvida, de modo a conduzir o leitor pelo processo de raciocnio que o autor ou a sua equipa seguiram; justificar devidamente as opes tomadas no decurso do projeto, apresentando, quando tal for relevante, as vrias opes que estavam disponveis, aquela que foi selecionada e os critrios que presidiram a essa escolha; recorrer a documentao tcnica e a abstraes para apresentar e documentar a soluo desenvolvida e a sua arquitetura

No caso da documentao tcnica, deve-se ter em conta que a compreenso de qualquer fenmeno ocorre por fases: primeiro, uma viso geral e de alto nvel (aquilo a que os ingleses chamam the big picture), depois a anlise de partes dessa imagem global, descendo gradualmente at ao detalhe. Por isso, a documentao de qualquer projeto deve ser hierrquica: deve haver um ponto de entrada, de alto nvel, que d a viso global. Este ponto de entrada pode, por exemplo, ser um diagrama geral do software ou um esquema de blocos de um equipamento de hardware. Depois, cada um dos elementos constantes nesse diagrama geral detalhado no nvel hierrquico inferior, em mais detalhe, e assim sucessivamente, at ao nvel de detalhe considerado suficiente.

Tabelas, figuras e grficos


As tabelas permitem uma apresentao ordenada dos valores obtidos no decurso de um trabalho experimental. Os grficos tm por funo condensar a informao contida nos dados numricos e apresentla de uma forma mais facilmente apreensvel. Vamos recorrer a um exemplo para melhor compreender o uso de tabelas, figuras e grficos num relatrio tcnico ou cientfico. Esse exemplo ser a medio da corrente que atravessa uma resistncia, quando aplicada uma diferena de potencial aos seus terminais. A figura 3 apresenta os elementos utilizados nesta experincia e as grandezas fsicas que sero medidas.
/media/truecrypt1/Textos/Didacticos/Guia Redaccao Relatorios/Guia redaccao relatorios.odt, rev 11

Pedro Fonseca Guia para a Redaco de Relatrios

Neste caso s h um componente (a resistncia R) e medir-se- a corrente I e a tenso V . Mesmo em situaes simples, a figura torna claro qual o circuito objeto de estudo, quais as grandezas fsicas medidas e qual a sua relao com o circuito.

V I R
Figura 3: Circuito analisado

As tabelas devem ser utilizadas sempre que h conjuntos de dados relacionados a apresentar; neste caso, a corrente I que atravessa R quando lhe aplicada uma tenso V. Um resultado possvel o da tabela 1. Nesta tabela, notar que: a varivel ou variveis independentes (neste caso, V) esto nas colunas esquerda; cada coluna tem a identificao da grandeza correspondente (V e I) e das respetivas unidades (V, volt, e A, ampere) cada linha corresponde a uma observao.
V (V) 0,33 0,47 0,62 0,75 0,87 1,02 1,23 I (A) 0,54 0,80 1,09 1,37 1,53 2,04 2,24

Tabela 1: Tenso v e corrente i na resistncia.

Com base nestes valores, construiu-se o grfico 1. Este grfico apresenta no s os valores lidos, como uma estimativa da reta que define a relao entre V e I.
VxI 2,50 2,00 1,50 I (A) 1,00 0,50 0,00 -0,50 0 0,2 0,4 0,6 V (V) 0,8 1 1,2 1,4 I est im.

Grfico 1: Tenso e corrente na resistncia

A utilidade dos grficos apelar para a nossa capacidade de perceo visual para realar as relaes existentes entre os dados obtidos. Neste caso, embora a Tabela 1 e o Grfico 1 apresentem os mesmos dados, muito mais fcil perceber atravs do grfico que existe uma relao de proporcionalidade direta entre a tenso (V) e a corrente (I) numa resistncia, do que atravs dos valores na tabela. A informao, num caso ou noutro, exatamente a mesma. A nossa perceo do significado desses dados (e da informao que contm)
/media/truecrypt1/Textos/Didacticos/Guia Redaccao Relatorios/Guia redaccao relatorios.odt, rev 11

Pedro Fonseca Guia para a Redaco de Relatrios

que diferente. Um outro tipo de indicao que os grficos podem fornecer a presena de sazonalidade ou periodicidade nos dados. Por exemplo, o grfico 2 apresenta os dados sobre o consumo de cerveja no Reino Unido, em milhares de hl, entre Janeiro de 2000 e Dezembro de 2003 ([2]). evidente daqui, numa primeira anlise, que o consumo de cerveja tem caractersticas sazonais, apresentando uma queda marcada no ms de Janeiro.
Consumo de cerveja no Reino Unido
7000 6000 5000
x1000 hl

4000 3000 2000 1000 0 Jan 00

Jul 00

Jan 01

Jul 01

Jan 02

Jul 02

Jan 03

Jul 03

Grfico 2: Consumo de cerveja no Reino Unido

Os grficos permitem assim uma primeira abordagem ao tratamento dos dados obtidos. Em geral, necessrio um processamento estatstico posterior mais elaborado, de modo a confirmar analiticamente qualquer observao qualitativa.

Questes de forma
Todas as tabelas, grficos e figuras de um trabalho cientfico devem estar inequivocamente identificados. A identificao feita atravs de um nmero de ordem e de uma legenda para cada. Deve existir uma numerao independente para cada tipo de elemento (figura, grfico ou tabela). A legenda deve ser concisa e descrever o contedo do elemento respetivo. Quando se faz no texto alguma referncia a um grfico, tabela ou figura, deve-se sempre indicar qual o nmero do elemento a que se alude. A criao das legendas para as figuras, grficos e elementos afins, a sua numerao automtica, bem como a referncia cruzada destes elementos no texto, so hoje em dia amplamente facilitadas pela utilizao das facilidades dos programas de edio de texto.

Citaes e referncias
Utilizao de referncias
Uma afirmao includa num texto cientfico pode ser vista como um de trs casos: o seu contedo do conhecimento geral; o contedo da frase original e resulta do trabalho do autor; a frase no original, mais foi dita por outra pessoa; tem origem noutro trabalho.

No primeiro caso, quando a afirmao do conhecimento geral, no faz sentido o autor justific-la. O segundo caso, quando a afirmao original e resulta do trabalho do autor, aquele que traz valor a um trabalho. No entanto, uma afirmao original no pode ser includa sem ser solidamente suportada pelo trabalho desenvolvido e apresentado no texto. Esse suporte experimental confere ao autor a autoridade de afirmar as suas concluses, que resultam de um processo desenvolvido segundo o mtodo cientfico.
/media/truecrypt1/Textos/Didacticos/Guia Redaccao Relatorios/Guia redaccao relatorios.odt, rev 11

Pedro Fonseca Guia para a Redaco de Relatrios

10

No terceiro caso, o autor socorre-se de uma outra pessoa para afirmar alguma coisa. Esta atitude no tem nada de incorrecto. Pelo contrrio, demonstra que o autor, antes de iniciar o trabalho, se dedicou ao estudo do assunto e viu quem j tinha efectuado trabalhos semelhantes. No entanto, deve-se deixar bem explcito que se est a socorrer do trabalho de outrem, que se est a fazer uma citao. Isso feito atravs das referncias. De um modo geral, a referncia diz respeito a citaes ou a menes de trabalho que est descrito nalgum outro lado. No precisa de ser trabalho efectuado por um autor diferente. Se a justificao para o que se afirma no texto j foi feita nalgum outro trabalho anterior do autor, por exemplo, este deve indic-lo como uma referncia. No precisa de apresentar, por extenso, o fundamento da sua afirmao: indica apenas onde este se encontra, proporcionando os meios ao Leitor para, caso tenha essa curiosidade, a poder consultar. As referncias assumem, assim, duas funes: 1. identificar o autor de uma afirmao, quando esta no original, reconhecendo com assim os direitos de propriedade intelectual sobre o trabalho original; e 2. fornecer os elementos necessrios para se aprofundar o estudo de aspectos que no so abordados em detalhe no texto. Esta segunda funo importantssima para o desenvolvimento de trabalho cientfico. Permite a quem l um artigo saber onde o autor estudou esse assunto e onde se pode ir buscar mais informao.

Como indicar as referncias


As formas de indicar referncias em textos so mltiplas: podem ser feitas com numerao, usando o nome dos autores, etc. No entanto, todas elas cumprem a mesma funo: identificar no texto, de forma compacta, um trabalho que est identificado, por extenso, numa seco de Bibliografia ou Referncias. A escolha pode ser uma questo de gosto pessoal ou convenincia do autor ou, no caso de artigos cientficos, definida pelos editores da publicao a que o texto se destina. De um modo simples, para a indicao de referncias num texto, usa-se geralmente uma das seguintes formas: nmero de ordem ([1], [2], ...) sigla com o nome do autor e o ano de publicao.

Na indicao por nmero, a sequncia pode ser pela ordem em que as referncia aparecem no texto ou ento pela ordem alfabtica de referncias. No segundo caso, utiliza-se uma sigla composta, geralmente, a partir do nome do autor ou autores e o ano de publicao. No fim do texto, na seco com o ttulo Referncias bibliogrficas (ou Referncias, ou Bibliografia, ) inclui-se a lista das fontes mencionadas no texto, as referncias. Cada uma identificada pelo nmero ou sigla utilizada, e faz-se a identificao completa, com: o nome do autor, comeando pelo ltimo apelido; o ttulo do artigo, escrito entre aspas; o nome da revista onde o artigo foi publicado (em itlico); o volume e o nmero da revista; o editor da revista; o local e a data da publicao; as pginas do artigo.

Nos artigos com vrios autores a norma mais comum : quando h dois autores, indicar o nome de ambos; quando forem 3 ou mais, indicar o nome do primeiro, seguido da expresso et al. (e outros).
/media/truecrypt1/Textos/Didacticos/Guia Redaccao Relatorios/Guia redaccao relatorios.odt, rev 11

Pedro Fonseca Guia para a Redaco de Relatrios

11

Os Servios de Biblioteca, Informao Documental e Museologia da Universidade de Aveiro disponibilizam documentao mais detalhada sobre a forma de incluir referncias bibliogrficas em textos cientficos e acadmicos ([3], [4]) apresentando tambm os vrios estilos para as referncias bibliogrficas.

Software para gesto bibliogrfica


Existem hoje vrios programas para fazer a gesto de bases de dados bibliogrficas. Estes programas tornamse especialmente interessantes quando tm ligao a editores de texto e permitem fazer automaticamente a insero de referncias. Neste caso, o programa de gesto bibliogrfica encarrega-se tambm da formatao das referncias no texto e na lista de referncias, de acordo com o estilo que for definido. O Zotero (http://www.zotero.org) uma extenso do Firefox (http://www.firefox.com) que permite recolher, gerir, citar e partilhar as fontes de informao (artigos, livros, pginas Web, ). Tem a vantagem de ser gratuito e multi-plataforma, pois suporta-se no Firefox. Sendo uma aplicao Web, permite aceder base de dados bibliogrfica em qualquer computador com ligao rede. Permite a importao e exportao num conjunto variado de formatos, permitindo a sua interoperacionalidade com outras aplicaes. Os plugins para o Microsoft Word e OpenOffice Writer permitem a insero automtica de referncias no texto utilizando estes processadores (o presente texto foi escrito usando o Writer; as referncias bibliogrficas foram inseridas com recurso ao Zotero). Em ambientes mais sofisticados, sugere-se a utilizao do formato BibTex. Este formato utilizado em conjunto com o processador de texto LaTeX e a soluo para as situaes em que se pretende um resultado com elevada qualidade grfica.

Plgio
So por demais os exemplos de situaes em que h a incluso, no trabalho assinado por algum, de extensas partes (quando no citao integral) de trabalhos realizados por outros, sem qualquer referncia ao trabalho original. O recurso ao plgio inaceitvel e, por isso, vrias organizaes ligadas publicao tcnica e cientfica definiram regras e princpios para lidar com (leia-se erradicar) o plgio. O IEEE (The Institute of Electrical and Electronic Engineers, Inc.) definiu 5 nveis de gravidade de plgio [5] e disponibiliza no seu site um ficheiro pps com um tutorial sobre plgio e a sua erradicao [6]. A deteo de situaes de plgio em material enviado ao IEEE para publicao leva aplicao de sanes aos autores em causa, sendo as funes determinadas em funo do nvel de plgio identificado. Nos casos mais graves, as sanes incluem a divulgao da situao no ieeexplore.ieee.org (o site de pesquisas das publicaes do IEEE) e a proibio de publicao em revistas do IEEE por um prazo entre 3 a 5 anos. Sendo as revistas do IEEE uma das referncias na rea da Eletrnica, Telecomunicaes e Informtica, fcil de ver o impacto que estas sanes podem ter na carreira de um investigador.

Questes de linguagem
A forma como o texto escrito importante para a qualidade do relatrio. falsa a ideia que, se um trabalho apresenta bons resultados cientficos ou bastante avanado, desnecessria a utilizao de linguagem correta Em primeiro lugar: a ausncia de erros (gramaticais e de ortografia) essencial. A primeira impresso de quem l um texto dada pela correo formal do texto. Um texto com erros em nada abona a favor de quem o escreveu e sugere que o Autor do texto desleixado e pouco preocupado com a correo (formal e, por extenso, de contedo) dos textos que produz. Se no est preocupado com a forma, pouco provvel que o esteja tambm com o contedo. O texto do Relatrio deve ser objetivo, conciso e isento de ambiguidades. Todas as afirmaes nele contidas devem ser baseadas em elementos concretos, a que o Leitor tem acesso e que pode avaliar ( objetivo), deve
/media/truecrypt1/Textos/Didacticos/Guia Redaccao Relatorios/Guia redaccao relatorios.odt, rev 11

Pedro Fonseca Guia para a Redaco de Relatrios

12

ser sinttico, utilizando apenas as palavras necessrias e evitando ornatos e redundncias, sem deixar de mencionar todos os elementos necessrios (conciso) e deve ter leituras nicas, isto , em nenhum caso a leitura de um trecho do Relatrio deve deixar o Leitor em dvida quanto ao seu significado ( isento de ambiguidades). Em termos de estilo, deve dar-se preferncia a frases curtas, expressas na voz cativa Nos textos tcnicocientficos, a repetio de palavras melhor aceite do que em textos literrios. Na escolha de vocabulrio, h uma regra de ouro: nunca empregar palavras de que no se domine o seu significado! Ateno: no conhecer o seu significado; dominar o significado da palavra utilizada! Isto implica saber qual o seu significado comum e quais so todos os significados menos comuns e todas as utilizaes subjetivas desse termo. conhecer as vrias leituras possveis para o termo utilizado, de modo a saber todas as implicaes do seu emprego. So infelizmente comuns as situaes em que o Autor recorre a um determinado termo (porque est na moda, porque uma palavra cara, ) e, por no conhecer bem o seu significado, o aplica fora de contexto, mostrando assim ao mundo a sua ignorncia. Na organizao sequencial do texto, deve ter-se o cuidado de fornecer tanta informao a-priori quanto possvel, antes de descrever uma observao ou fazer um comentrio. Dito de outro modo: devem-se evitar as referncias para a frente (um qualquer aspeto explicado mais frente no texto). Esta situao torna a leitura mais difcil, sendo por isso de evitar.

Concluses
Um relatrio uma ferramenta essencial para qualquer profissional em Cincias ou Engenharia. Para ser eficaz, um relatrio deve ser Objetivo, Conciso, Completo e Conclusivo. A estrutura de um relatrio deve ser adaptada situao concreta em que utilizado, havendo um padro que comum grande maioria das situaes: uma introduo, a apresentao da metodologia utilizada, os resultados e a anlise e discusso dos resultados obtidos. A autenticidade dos que relatado deve ser escrupulosamente respeitada e todas as alegaes sobre a autoria do trabalho apresentado devem ser corretas e verdadeiras; nesse sentido, o plgio ou qualquer outra situao menos correta inadmissvel. Para alm das questes de contedo, h tambm que ter em ateno todas as questes de forma, nomeadamente o que se relaciona com a correo da linguagem utilizada, por forma a garantir a legibilidade e objetividade do trabalho apresentado.

Bibliografia
[1] J. B. McCormack, R. K. Morrow, H. F. Bare, R. J. Burns, and J. L. Rasmussen, The Complementary Roles of Laboratory Notebooks and Laboratory Reports, IEEE Transactions on Education, vol. 34, pp. 133-137, 1991. [2] National Statistics Data Home Page. [Online]. Available: http://www.bized.co.uk/dataserv/ons/data/data.htm. [Accessed: 14-Sep-2010]. [3] SBIDM, Referncias bibliogrficas: manual de normas e estilos, Universidade de Aveiro, 2010. [4] SBIDM, Servios de Documentao referncias bibliogrficas - normas e estilos. [Online]. Available: http://www.ua.pt/sbidm/biblioteca/PageImage.aspx?id=12012. [Accessed: 18-Oct-2010]. [5] The Five Levels Of Plagiarism. [Online]. Available: http://www.ieee.org/portal/site/tionline/index.jsp? pageID=institute_level1_article&TheCat=&article=tionline/legacy/inst2004/dec04/12w.pubsb1.xml. [Accessed: 12-Sep-2010]. [6] Plagiarism Tutorial. [Online]. Available: http://www.ieee.org/documents/plagiarism.pps. [Accessed: 12-Sep-2010].

/media/truecrypt1/Textos/Didacticos/Guia Redaccao Relatorios/Guia redaccao relatorios.odt, rev 11

Pedro Fonseca Guia para a Redaco de Relatrios

13

Bibliografia complementar
Apresentam-se nesta lista alguns elementos complementares sobre o tpico da escrita de Relatrios e outros textos tcnico-cientficos. L. Correia, Contributos para a Escrita de um Relatrio. Available: http://grow.lx.it.pt/education/contescrelatorio_20080928.pdf Handbook: Laboratory Reports. [Online]. Available: http://www.ecf.utoronto.ca/~writing/handbooklab.html. [Accessed: 10-Sep-2010]. W. Zinsser, On writing well : the classic guide to writing nonfiction, 25th ed. New York: Quill, 2001. Oxford University Press: The ACS Style Guide: A Manual for Authors and Editors, Second Edition. [Online]. Available: http://www.oup.com/us/samplechapters/0841234620/?view=usa. [Accessed: 14-Sep2010]. A. Ruina, Practical Technical Writing Advice. [Online]. Available: http://ruina.tam.cornell.edu/hplab/Practical_Writing_advice.html. [Accessed: 14-Sep-2010]. C. A. Vidoli, Technical Report Writing. Cleveland, Ohio, USA: Lewis Research Center, NASA, 2000. http://grcpublishing.grc.nasa.gov/editing/vidcover.cfm Writing at the University of Toronto. [Online]. Available: http://www.writing.utoronto.ca/. [Accessed: 22-Aug-2010]. Writing Guidelines for Engineering and Science Students. [Online]. Available: http://www.writing.engr.psu.edu/. [Accessed: 10-Sep-2010].
Sobre o autor Pedro Fonseca. Licenciado em Eng. Eletrnica e Telecomunicaes pela Universidade de Aveiro, MSc em Electronic Engineering pelo University College of North Wales, Doutorado em Eletrnica pela Un. de Aveiro e em Informtica pelo Institut National Polytechnic de Lorraine, em Frana. O seu percurso profissional dividido entre o meio acadmico e empresarial. , desde 1991, docente do Departamento de Eletrnica, Telecomunicaes e Informtica da Universidade de Aveiro, onde Professor Auxiliar e investigador do IEETA (Instituto de Engenharia Eletrnica e Telemtica de Aveiro), desenvolvendo investigao em Robtica e Sistemas Eletrnicos Embarcados na equipa ATRI (Atividade Transversal de Robtica Inteligente). Trabalhou e colaborou em vrias empresas nacionais, como consultor e como colaborador interno, nas reas de Robtica, Automao Industrial e Eletrnica, em funes de projeto e de Direo.
Esta obra foi licenciada com uma Licena Creative Commons - Attribution-NonCommercial-ShareAlike 2.5 Portugal. Para ver uma cpia desta licena, visite http://creativecommons.org/licenses/by-nc-sa/2.5/pt/ ou envie um pedido por escrito para Creative Commons, 171 Second Street, Suite 300, San Francisco, California 94105, USA.

Rev. 6 7 11

Data

Descrio

24.02.2011 Incluso de seco sobre Relatrios de Projecto 24.09.2011 Adaptao ao NAO. 8.10.2011 Correo dos links dos ficheiros modelo. 23.07.2012 Reviso do texto.

Verso actual: 11

/media/truecrypt1/Textos/Didacticos/Guia Redaccao Relatorios/Guia redaccao relatorios.odt, rev 11