Guia para a redaco de relatrios

Pedro Fonseca Janeiro 2002

O

que um relatrio Organizao de um relatrio Linguagem Tabelas, figuras e grficos Citaes e referencias Algumas normas avulsas... Links Referncias

Introduo
Este texto apresenta algumas "deixas" para ajudar na redaco de relatrios tcnicos ou cientficos. As idias 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 escrita pode determinar o sucesso ou insucesso de uma carreira. Exagero? Vejamos:

empresa A encomendou empresa B um determinado software. O cdigo continua a pertencer empresa B, que se compromete entregar empresa A apenas o binrio (executvel). Entregue o binrio da parte feita pela empresa B, a aplicao no funciona. A responsabiliza B pelo facto do 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 que a empresa B no faz o que foi pedido. Como se faz isso? Com um relatrio. Se se pensar que A uma PME, fcil que um projecto volumoso corresponda ao investimento do trabalho de toda a equipa durante 6 meses, e que a viabilidade econmica de A dependa desse relatrio.

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. (Estas quatro perguntas so conhecidas na literatura inglesa como os 4 Ws: who, what, when, where). 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 (adaptado de [1]):
Resumo Descrio

do problema Aparelhagem e equipamento Procedimento Resultado dos testes Anlise dos resultados Concluses Referncias Anexos

Resumo: Descrio:

Descreve sumariamente o trabalho e o relatrio no seu conjunto; Apresenta o problema que se pretende resolver ou atacar. Apresentam-se aqui tambm outras abordagens que j tenham sido feitas, diversos mtodos para o fazer, qual a soluo escolhida e a razo (ou razes) da escolha;

Aparelhagem: 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.. Descreve-se como que o trabalho foi feito. 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. 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. Neste seco, procede-se transformao dos resultados "em bruto" apresentados na seco anterior que possam ser utilizados: aplicao de frmulas, extraco de mdias e desvios padres, etc.. Avaliam-se os resultados obtidos: se esto de acordo com a teoria, se os erros so elevados, se os resultados so credveis. 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 nesta caso constar de uma lista aparte. Conjunto de documentao diversa, utilizada para fundamentar o texto do relatrio. Nos anexos podem estar: esquemas elctricos, 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.

Anlise:

Concluses: Referncias:

Anexos:

Como se disse antes, a estrutura do relatrio depende do tipo de trabalho que ele relata. O exemplo apresentado orientado para a realizao de trabalho experimental: os pontos incluem a descrio da Aparelhagem e Equipamento, uma actividade nitidamente ligada realizao de experincias em laboratrios. Convm lembrar que alguns destes pontos, sem bem que paream s para trabalho de laboratrio, dizem tambm respeito construo de mquinas, aparelhos ou sistemas! Por exemplo, o ponto de Procedimentos. A construo de uma mquina, ou aparelho, feita a partir de

determinadas especificaes. Um dos pontos mais importantes de um relatrio do projecto dessa mquina a confirmao que a mquina cumpre efectivamente os requisitos impostos. Isso s pode ser feito com medidas experimentais. A Anlise dos Resultados e as Concluses so dois dos pontos mais importantes . No entanto, so normalmente esquecidos em muitos trabalhos. A Anlise dos Resultados permite obter informao que seja rapidamente assimilvel pelo leitor. Por exemplo, se se estivesse a fazer o estudo do movimento de um corpo num plano, seria nesta seco que se relacionavam os valores do espao percorrido com o tempo, e se verificaria a relao entre um e o outro. As concluses permitem, entre outras coisas, verificar se a pessoa que fez o trabalho percebeu, ou no, o que estava a fazer. Uma concluso errada o suficiente para invalidar todo um trabalho. Do mesmo modo, um relatrio de um trabalho experimental que no apresente quaisquer concluses tem um valor muito relativo.

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. (J agora, como se consegue isso sem um Portugus correcto?) As frases utilizadas devem ser curtas. Deve-se evitar a utilizao da voz passiva, e escrever as frases na voz activa. Outro aspecto a ter em ateno o de fornecer tanta informao a-priori quanto possvel, antes de descrever uma observao. Deve-se tambm evitar a utilizao de frases encadeadas umas nas outras.

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 apresent-la de uma forma mais facilmente apreensvel.

Referncias a tabelas, figuras e grficos

Um trabalho cientfico deve ser isento de ambiguidades. 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 respectivo.. Quando se faz no texto alguma referncia a um grfico, tabela ou figura, deve-se sempre indicar qual o nmero respectivo.

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 algo 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. 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 prtico, 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. 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 outras pessoas, sem qualquer referncia ao trabalho original. (Esse infelizmente o caso de um dos links includo nesta pgina...)

De um modo geral, a referncia refere-se a citaes 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 foi feita nalgum outro relatrio anterior do autor, por exemplo, este deve pr o seu trabalho como uma referncia. No precisa de apresentar, por extenso, o fundamento da sua afirmao: indica onde este se encontra. As referncias assumem assim duas funes: identificar o autor de uma afirmao, quando esta no original, e fornecer os elementos necessrios para se aprofundar o estudo de aspectos que no so abordados em profundidade no relatrio. Esta segunda funo importantssima para o desenvolvimento de trabalho cientfico. Permite a quem l um artigo saber onde o autor estudou sobre esse assunto e onde pode ir buscar mais informao sobre um assunto especfico.

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 resumida, um trabalho que estar descrito, por extenso, numa seco de Bibliografia ou Referncias. A escolha muitas vezes uma questo de gosto pessoal ou convenincia. comum encontrar referncias por nmero em textos curtos, sendo as referncias por sigla de texto mais utilizadas em textos longos. As principais revistas cientficas tm definidas as regras para fazer referncias, o que define alguns "estilos" na maneira de referenciar artigos, umas mais ligadas a Artes e Humanidades, outras mais comuns em Engenharia ou Medicina, ... 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, o ano de publicao e, mais raramente, o ttulo. Por exemplo, podem-se utilizar as primeiras letras do ltimo apelido do autor e o ano de publicao. Por exemplo, um artigo escrito em 1980 por Antnio Silva ficaria [SILVA80] ou [Sil80]. Quando este mtodo gera referncias repetidas (dois artigos escritos no mesmo ano pelo mesmo autor) acrescenta-se uma letra (A,B,...) sigla obtida. (Por exemplo, [Sil80] e [Sil80a]).

Quando existe mais do que um autor, utiliza-se a sigla normal para o primeiro autor, seguida das inicias dos restantes autores e do ano de publicao. Por exemplo, um artigo composto por Ana Lamy e Jos Carlos Malato em 1999 ficaria [LamM99]. Quando o nmero de autores muito grande (geralmente, maior do que trs ou quatro), as iniciais dos restantes autores so substitudas por um "+". Em qualquer dos casos, prtica comum indicar a referncias entre parnteses rectos ([1] ou [Sil80]). Por vezes, utilizam-se tambm barras (/1/ ou /Sil80/). Esta ltima forma, que hoje caiu em desuso, existe apenas para suprir a falta dos parnteses rectos na maioria das mquinas de escrever e deve ser evitada. No fim do texto, inclui-se a lista das 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 (este nome escrito em itlico ou, se tal no for possvel, sublinhado); o volume e o nmero da revista; o editor da revista; o local e a data da publicao; as pginas do artigo. Quando um artigo tiver vrios autores, indicam-se todos os autores, at um nmero mximo estipulado. Quando o nmero de autores for superior a este mximo, indica-se o nome do primeiro e em seguida a expresso et al. (e outros). A indicao do nmero e volume da revista pode ser feita em texto (por exemplo, Vol. 35, n 4). Outras vezes, a indicao do volume e nmero abreviada, escrevendo-se o nmero do volume e, entre parnteses, o nmero da revista -por exemplo, a revista nmero 4 do volume 35 indicada como 35(4). No caso de livros, a indicao idntica, excepo do ttulo do artigo, que no se aplica. Hoje em dia existem vrios softwares para fazer a gesto de bases de dados bibliogrficas e que inclusiv fazem automaticamente a insero de referncias num texto. Para quem usa o processador Latex, o Bibtex um programa que insere automaticamente as referencias no texto, fazendo a sua numerao e compilao segundo o estilo definido.

Algumas normas avulsas...

Evitar

mencionar problemas de tempo (ou falta dele...), de equipamento ou outros de natureza idntica. Apresentar de forma clara qual o ponto em que o trabalho se encontra na data limite para a sua concluso, deixando bem claro quais os objectivos que foram cumpridos e quais os que no foram. 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 nivel 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).

Links
Pginas com informao geral
Writing

Guidelines for Engineering and Science Students (http://filebox.vt.edu/eng/mech/writing/) Site com informao sobre vrios aspectos da redaco de textos em Cincias e Engenharia. Virtual Reference Desk: Writing (http://www.kyvl.org/html/ref/subwriting.shtml) Links para ajudar na escrita de textos tcnicos. Writing Resources on the World Wide Web (http://web.mit.edu/uaa/www/writing/links/) Embora muito dirigido para o Ingls, tem alguns links sobre aspectos que so vlidos qualquer lngua. Technical Writing (http://www.frostburg.edu/dept/engl/gartner/techwrit.htm) Informao variada

Pginas diversas com guias para a elaborao de relatrios:

Guide

to Laboratory Report Writing (http://www.iit.edu/~writer/MMAE/maeguide1.html) Guia para a escrita de relatrios (como o prprio nome indica?) com sugesto de estrutura e alguns considerandos em volta do "Porqu" e "Para qu" dos relatrios de trabalhos de laboratrio. Um guia para a escrita de relatrios (http://www.fe.up.pt/~campilho/IM/GUIOES/guiaRelatorio.htm) Vejam em conjunto com o anterior e tirem concluses...
Contributos

para a escrita de um relatrio (http://mega.ist.utl.pt/~leec/tfcs/ContEscRelat3.doc) Pgina da LEEC do IST. Guide to Writing Laboratory Reports (http://cee.ce.uiuc.edu/Classes/cee210/labs/guide.pdf) Technical Report Writing (http://134.117.206.17/www/resources/report_writing/pages/vidcover.htm) Guia da Nasa para escrita de relatrios tcnicos. Fastfax: Writing Scientific Lab Reports (http://www.learningcommons.uoguelph.ca/writing/fastfax/labreports.htm) Guia para escrita de relatrios, com alguns comentrios sobre a razo da existncia de cada uma das seces em que habitualmente se divide um relatrio.

Referncias
[1.] McCormack, John B. et al., "The Complementary Roles of Laboratory Notebooks and Laboratory Reports", IEEE Trans. on Education, 34(1), Fev. 1991, pp133-137.