Guia para a redação de relatórios

Pedro Fonseca pf@ua.pt

Guia para a reda??o de relat?rios

Departamento de Eletr?nica, Telecomunica??es e Inform?tica Universidade de Aveiro

Introdu??o

A escrita de Relat?rios faz parte integrante da atividade de qualquer profissional na ?rea t?cnica e cient?fica, seja ele Engenheiro ou Investigador, quer na sua forma??o, quer no exerc?cio da profiss?o.

O presente texto apresenta algumas "deixas" para ajudar na reda??o de relat?rios t?cnicos ou cient?ficos. As ideias e os conceitos sugeridos aqui n?o s?o dirigidos a nenhuma situa??o em particular. Pretende-se, sobretudo, apresentar algumas das quest?es mais importantes em torno da escrita de relat?rios t?cnicocient?ficos e dar algumas linhas mestras para orientar a escrita de um texto cient?fico.

Juntamente com este texto, ? divulgado um Modelo de Relat?rio (em formato odt e pdf), organizado segundo a estrutura proposta.

O que ? um relat?rio

O relat?rio ? o documento atrav?s do qual um t?cnico, engenheiro ou cientista faz o relato da forma como realizou um determinado trabalho. O objetivo ? comunicar (transmitir) ao leitor e registar para mem?ria futura a experi?ncia acumulada pelo autor na realiza??o do trabalho e os resultados que obteve.

Os resultados apresentados num relat?rio, como em qualquer outro texto cient?fico, devem ser verific?veis. Esse ? um aspeto important?ssimo e frequentemente esquecido. O que ? dito num relat?rio n?o ? verdade por causa de quem o escreve (por muito importante que seja o autor). ? verdade (cientificamente) porque foi determinado segundo um m?todo conhecido e descreve um trabalho que (para poder ser considerado verdadeiro) est? sujeito ao escrut?nio dos pares. Em ci?ncia n?o h? verdades absolutas. A verdade (ou a melhor aproxima??o que conseguimos dela) ? conseguida atrav?s do consenso de todas as pessoas que queiram participar numa discuss?o.

Por isso, um relat?rio 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 ? v?lido, se foi obtido por m?todos corretos e que n?o h? vicia??o dos resultados. ? assim que se garante que o que ? transmitido ? cientificamente verdadeiro: qualquer resultado, para ter valor cient?fico, deve poder ser reproduzido. Um resultado que s? uma pessoa consegue obter n?o tem qualquer validade cient?fica.

N?o h? um modelo ?nico para o relat?rio. O tipo de relat?rio, a sua estrutura, os objetivos que pretende atingir, s?o aspetos que dependem do tipo de problema que se tentou resolver. Mas, na sua ess?ncia, tudo se resume a:

? uma pergunta (o problema)

? uma resposta (as conclus?es do relat?rio)

O Relat?rio 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 conclus?es do Relat?rio.

Ao escrever um Relat?rio (ou qualquer outro texto de ?ndole t?cnico-cient?fica), estes dois conceitos devem estar sempre bem presentes na mente do autor:

De que ponto partiu? Qual foi o problema que se prop?s resolver?

Aonde chegou? Qual a resposta que conseguiu obter?

N?o vale a pena escrever se estas duas quest?es n?o estiverem claramente respondidas.

Figura 1: As duas quest?es fundamentais

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

Pedro Fonseca ? Guia para a Redac??o de Relat?rios

2

Para qu? relat?rios?

A utilidade de um relat?rio (e, sobretudo, a utilidade de saber escrever bem um relat?rio) ? muitas vezes ignorada pela maioria dos estudantes. O relat?rio ? "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 relat?rios s?o 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 relat?rio ? escrita pode determinar o sucesso ou insucesso de uma carreira.

Exagero? Vejamos:

? A empresa A encomendou ? empresa B um determinado software. O c?digo continua a pertencer ? empresa B, que se compromete entregar ? empresa A apenas o c?digo execut?vel (o bin?rio). Ap?s a entrega, verifica-se que a aplica??o n?o funciona. A empresa A responsabiliza o seu fornecedor pelo facto de o software entregue n?o cumprir todas as especifica??es. A quest?o n?o ? resolvida amigavelmente e segue para tribunal. Em tribunal, a empresa A ter? que provar que o produto fornecido pela empresa B n?o corresponde ao que foi pedido. Como se faz isso? Com um relat?rio. Se se pensar que A ? uma PME, ? f?cil que um projeto volumoso corresponda ao investimento do trabalho de toda a equipa durante 6 meses e que a viabilidade econ?mica de A dependa desse relat?rio.

Caracter?sticas de um Relat?rio

Um Relat?rio deve ser:

Objetivo: um Relat?rio cient?fico ou t?cnico lida com dados concretos e evid?ncias suportadas pela realidade. S?.

Conciso: deve ser t?o curto quanto poss?vel, contendo apenas os elementos que s?o necess?rios para cumprir a sua fun??o. N?o deve ter elementos apenas para encher: nem texto desnecess?rio (a chamada "palha"), nem dados que n?o sejam relevantes para o objeto da an?lise.

Completo: deve conter todos os elementos necess?rios ? compreens?o do relato que ? feito e do trabalho que foi desenvolvido, sem omiss?es.

Conclusivo: n?o deve deixar d?vidas ao Leitor. Todas as quest?es levantadas no ?mbito do trabalho desenvolvido t?m que ser encerradas. Podem ser encerradas respondendo claramente ? quest?o ("A corrente que passa atrav?s de uma resist?ncia ? diretamente proporcional ? tens?o que lhe ? aplicada") ou, quando n?o haja uma resposta definitiva, devem ser identificados os aspetos a estudar que poder?o contribuir para que se atinja essa resposta.

Organiza??o de um relat?rio

Identifica??o

A identifica??o ? indispens?vel em qualquer trabalho escrito. Quando um trabalho escrito chega ?s m?os de algu?m, h? necessidade de saber mais alguma coisa do que o seu conte?do: quem o escreveu, se o artigo ou relat?rio est? atualizado, etc. Num trabalho que n?o est? identificado, n?o ? poss?vel responder a estas quest?es.

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

Pedro Fonseca ? Guia para a Redac??o de Relat?rios

3

As 5 quest?es

Para saber qual a informa??o necess?ria para identificar um trabalho, pode recorrerse ?s cinco perguntas b?sicas do jornalismo: quem, o qu?, quando, onde e porqu?. (Estas quatro perguntas s?o conhecidas na literatura inglesa como os 5 Ws: who, what, when, where, why).

As quatro primeiras quest?es (Quem, O qu?/T?tulo, Quando e Onde) s?o dados curtos que devem estar presentes na capa do Relat?rio ou, se n?o existir capa, na primeira p?gina. O "Porqu?" ? geralmente respondido pelo Resumo do Relat?rio.

Quem

Who

Indentifica o autor, ou autores do trabalho.

O qu?

What

O que foi feito no relat?rio. T?tulo

Quando When Data e local de realiza??o do Onde Where trabalho

Porqu? Why

Raz?o de ser do trabalho (porque ? que o autor realizou o trabalho; porque ? que o leitor o h?-de ler)

Figura 2: As 5 quest?es

Informa??o adicional

Para al?m das 5 quest?es b?sicas, pode haver mais informa??o necess?ria para identificar o trabalho. Alguns exemplos de informa??o complementar s?o:

? a institui??o onde o trabalho foi realizado (universidade, empresa, ...) ou para a qual o trabalho foi realizado (podem n?o ser a mesma);

? o ?mbito em que o trabalho foi efetuado No caso de um relat?rio 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 respons?vel pelo seu enquadramento na institui??o (o professor da cadeira, o orientador de est?gio ou de doutoramento, ...);

? a institui??o que subsidiou ou financiou o trabalho.

Estrutura

A estrutura num texto surge por dois tipos de necessidades: por um lado, ? necess?rio, a quem escreve, organizar as suas ideias antes de escrever. Por outro lado, essa organiza??o 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 prepara??o de textos t?cnicos ou cient?ficos, n?o se come?a a escrever na primeira linha e se continua, sem interrup??es, at? ? ?ltima. Antes disso, ? necess?rio definir primeiro uma estrutura com os t?picos principais que depois s?o desenvolvidos em mais pormenor. O processo ? repetido at? se obter uma estrutura suficientemente fina que permita passar diretamente para a escrita do texto. A estrutura??o facilita assim a escrita de um trabalho.

Um trabalho escrito deve aparecer ao leitor como uma entidade uniforme. Deve ter-se a sensa??o de que se est? a ler um ?nico texto, e n?o uma sequ?ncia de textos diferentes. ? preciso que o leitor seja conduzido pelo texto do trabalho desde o princ?pio ao fim. Deve come?ar a ler na primeira linha e seguir o trabalho at? ao fim, sem esfor?o. Para que tal aconte?a ao longo de v?rias p?ginas, ? necess?ria a exist?ncia 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 Redac??o de Relat?rios

4

Elementos da estrutura

Uma poss?vel estrutura, que ? utilizada no modelo de Relat?rio que acompanha este texto, ? a seguinte (adaptado de [1]):

? Resumo ? Introdu??o ? Descri??o do problema ? Aparelhagem e equipamento ? Procedimento ? Resultados ? An?lise ? Conclus?es ? Refer?ncias ? Anexos Esta estrutura ? especialmente adequada a trabalhos laboratoriais. No caso de trabalhos de conce??o e projeto, poder? haver algumas altera??es, que s?o mencionadas mais ? frente (sec??o Relat?rios de projeto, p?g. 7).

Resumo

O Resumo deve descrever sumariamente o trabalho e o relat?rio no seu conjunto. Sumaria de forma clara, concisa e completa os conte?dos do Relat?rio, incluindo o problema abordado, a metodologia utilizada, os resultados e as conclus?es. Deve ser a ?ltima sec??o a ser escrita, apenas quando tudo o resto j? est? terminado.

O Resumo ? um texto que, n?o devendo exceder dois par?grafos, consegue captar toda a ess?ncia do que ? transmitido no Relat?rio. A decis?o de ler ou n?o um relat?rio na sua totalidade ? muitas vezes decidida com base no Resumo: conforme a impress?o com que fica do Resumo, o Leitor vai decidir se vale a pena, ou n?o, continuar a ler o resto do relat?rio. Cabe ao Autor fazer um resumo que cative o Leitor e o leve a interessarse pelo resto do Relat?rio.

A linguagem utilizada no resumo deve, na medida do poss?vel, evitar o recurso ao jarg?o t?cnico, de modo a permitir a sua leitura e compreens?o por quem n?o seja especialista da ?rea.

Introdu??o

A Introdu??o faz a apresenta??o geral do trabalho descrito no Relat?rio: qual o problema que se pretende resolver, o seu enquadramento e justifica??o, a metodologia utilizada. A Introdu??o d? ao Leitor, para al?m de uma perspetiva geral sobre o trabalho realizado, o porqu? da sua realiza??o e de que forma esse trabalho se relaciona com o problema que se prop?e tratar: se se trata de um aspeto particular do problema, se a resposta apresentada ? de aplica??o universal ou se est? sujeita a algumas condicionantes, ...

Descri??o do problema

Apresenta o problema que se pretende resolver ou atacar. Esta sec??o 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 t?cnicos e cient?ficos, a Descri??o do Problema ? complementada com o seu enquadramento, que pode incluir, por exemplo, o Estado da Arte, isto ?, uma apresenta??o do conhecimento existente no momento sobre o assunto tratado no texto. Quando aplic?vel, pode conter tamb?m uma an?lise das solu??es potencialmente concorrentes com a analisada no documento, ponderando as suas vantagens e desvantagens.

Esta sec??o detalha, quando necess?rio, os aspetos complementares em rela??o ? forma como se abordou o

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

Pedro Fonseca ? Guia para a Redac??o de Relat?rios

5

problema: se se est? a estudar um aspeto particular do problema, se a resposta encontrada est? dependente de hip?teses pr?vias ou se, pelo contr?rio, ? universal, ...

Aparelhagem e equipamento

Descreve-se a aparelhagem e o equipamento utilizado: que tipo de material, de que maneira foi utilizado, quais as liga??es entre os diversos aparelhos, etc.

Em trabalhos de ?ndole cient?fica, esta sec??o descrever?, por exemplo, os instrumentos de medida utilizados e a organiza??o de toda o equipamento experimental.

Em trabalhos de Engenharia, ? comum esta sec??o descrever a instala??o 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 sec??o apresenta a metodologia de trabalho utilizada. Devem-se descrever sem ambiguidade as a??es efetuadas, ou seja, como se realizou o trabalho descrito no Relat?rio.

Nalgumas situa??es, a sec??o Procedimento e a sec??o Aparelhagem e Equipamento poder?o ser reunidas numa s?, uma vez que ambas tratam de descrever a realiza??o do trabalho experimental (uma descreve a parte material, a outra a parte procedimental), recebendo, nessa altura, nome de "Metodologia" ou "M?todos".

Resultados

Apresentam-se aqui os resultados "em bruto" do trabalho. N?o deve haver qualquer interpreta??o dos resultados (tirar conclus?es, dizer se s?o 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 relat?rio devem ser verific?veis e o Relat?rio deve estar organizado de modo a permitir a sua reprodu??o.

An?lise dos Resultados

Neste sec??o, procede-se ? transforma??o dos resultados "em bruto", apresentados na sec??o anterior, de forma a que possam ser utilizados: aplica??o de f?rmulas, extra??o de m?dias e desvios padr?es, etc. O objetivo final do relat?rio ?, dado um problema, sustentar (isto ?, provar que ? verdadeira ou correta) a resposta que ? apresentada pelo autor. A An?lise dos Resultado permite obter informa??o que seja mais facilmente assimil?vel pelo leitor. Depois de estruturarmos os dados numa forma que seja conveniente ? nossa perce??o, vamos come?ar a fazer a sua an?lise e, muito especialmente, a sua an?lise cr?tica.

O desenvolvimento da fase de an?lise dos dados depende do enquadramento em que ? feito o trabalho de laborat?rio. Na investiga??o cient?fica, o trabalho tem geralmente por objetivo demonstrar (servir de suporte de prova a) uma teoria ou hip?tese. O tratamento dos dados incidir?, por exemplo, na procura das tend?ncias que relacionam as v?rias grandezas em an?lise. "Em que ? que o consumo de refrigerantes na popula??o jovem afeta a sua taxa de obesidade?" poder? ser uma quest?o 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 caracter?sticas de determinado equipamento est?o ou n?o conformes a esses resultados considerados "bons".

Em qualquer caso, o objetivo final ? sempre o mesmo: verificar a veracidade1 ou a falsidade de determinada

1 Na verdade, nenhuma experi?ncia consegue provar a veracidade de uma hip?tese. A realiza??o de uma experi?ncia com

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

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download