Guia para a redacção de relatórios

Por Pedro Fonseca

---

Introdução

Este texto apresenta algumas "deixas" para ajudar na redação de relatórios técnicos ou científicos. As idéias sugeridas aqui não são dirigidas para nenhuma situação em particular. Pretende-se sobretudo apresentar algumas das questões mais importantes em torno da escrita de relatórios tecnico/científicos e dar algumas linhas mestras para orientar na escrita de um texto científico.

O que é um relatório

O relatório é o documento através do qual uma professora um técnico, engenheiro ou cientista faz o relato da forma como realizou um determinado trabalho. O objectivo é comunicar (transmitir) ao leitor 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 aspecto 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). É verdadeiro (cientificamente...) porque foi determinado segundo um método conhecido e descreve um trabalho que (para poder ser 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 correctos 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.

O tipo de relatório, a sua estrutura, os objectivos que pretende atingir, tudo isto são aspectos 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)

Em resumo: Para haver um relatório, tem que haver uma resposta! O problema e a resposta têm que estar bem claros na cabeça de quem está a escrever um relatório! Não vale a pena tentar escrever um relatório sem se saber muito bem de onde se partiu onde se chegou.

O objectivo final do relatório é, dado um problema, sustentar (isto é, provar que é verdadeira ou correcta) a resposta que é apresentada pelo autor.

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. 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 binário (executável). Entregue o binário da parte feita pela empresa B, a aplicação não funciona. A responsabiliza B pelo facto do 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 que a empresa B não faz o que foi pedido. Como se faz isso? Com um relatório. Se se pensar que A é uma PME, é fácil que um projecto 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.

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á actualizado, etc.. Num trabalho que não está identificado, não é possível responder a estas questões.

As 4 questões

Para saber qual a informação necessária para identificar um trabalho, pode recorrer-se às quatro perguntas básicas do jornalismo: quem, o quê, quando e onde. (Estas quatro perguntas são 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 título. Quando e onde identificam o local e a data onde o trabalho foi efectuado.

Informação adicional

Para além das 4 questões básicas, pode haver mais informação necessária para identificar o trabalho. Geralmente, indica-se também o âmbito em que o trabalho foi efectuado. 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 projecto a que o trabalho está associado. Outra informação que pode aparecer como adicional, no caso de um trabalho ou relatório escolar, será o nome do orientador ou professor.

Estrutura

A estrutura aparece devido a dois tipos de necessidades: por um lado, é necessário a quem escreve organizar primeiro as suas ideias. Por outro lado, essa organização 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. 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. Depois, cada um desses tópicos é desenvolvido em mais pormenor. O processo é repetido até se obter uma estrutura que permita passar directamente para a escrita do texto. Cada um destes tópicos é então desenvolvido. A estruturação facilita assim a escrita de um trabalho.

Um trabalho escrito deve aparecer ao leitor como uma entidade uniforme. Deve-se ter 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.

Elementos da estrutura

Uma possível estrutura é a seguinte (adaptado de [1]):

• Resumo
• Descrição do problema
• Aparelhagem e equipamento
• Procedimento
• Resultado dos testes
• Análise dos resultados
• Conclusões
• Referências
• Anexos

Resumo:	Descreve sumariamente o trabalho e o relatório no seu conjunto;
Descrição:	Apresenta o problema que se pretende resolver ou atacar. Apresentam-se aqui também outras abordagens que já tenham sido feitas, diversos métodos para o fazer, qual a solução escolhida e a razão (ou razões) da escolha;
Aparelhagem:	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.. Descreve-se como é que o trabalho foi feito.
Procedimento:	Nesta secção, descreve-se qual a metodologia de trabalho utilizada. Devem-se descrever sem ambiguidade as acções efectuadas. Descreve como se faz o trabalho.
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.
Análise:	Neste secção, procede-se à transformação dos resultados "em bruto" apresentados na secção anterior que possam ser utilizados: aplicação de fórmulas, extracção de médias e desvios padrões, etc..
Conclusões:	Avaliam-se os resultados obtidos: se estão de acordo com a teoria, se os erros são elevados, se os resultados são credíveis.
Referências:	Lista dos artigos, livros e outra bibliografia consultada e que seja mencionada no texto do trabalho ou relatório. Podem também ser incluídos outros livros e artigos que se debrucem sobre a área do trabalho, devendo nesta caso constar de uma lista aparte.
Anexos:	Conjunto de documentação diversa, utilizada para fundamentar o texto do relatório. Nos anexos podem estar: esquemas eléctricos, listagens de programas, dados obtidos "em bruto", ... Em geral, os anexos contêm o que é informação complementar ou demasiado extensa para constar do texto do relatório.

Como se disse antes, a estrutura do relatório depende do tipo de trabalho que ele relata. O exemplo apresentado é orientado para a realização de trabalho experimental: os pontos incluem a descrição da Aparelhagem e Equipamento, uma actividade nitidamente ligada à realização de experiências em laboratórios. Convém lembrar que alguns destes pontos, sem bem que pareçam só para trabalho de laboratório, dizem também respeito à construção de máquinas, aparelhos ou sistemas! Por exemplo, o ponto de Procedimentos. A construção de uma máquina, ou aparelho, é feita a partir de determinadas especificações. Um dos pontos mais importantes de um relatório do projecto dessa máquina é a confirmação que a máquina cumpre efectivamente os requisitos impostos. Isso só pode ser feito com medidas experimentais.

A Análise dos Resultados e as Conclusões são dois dos pontos mais importantes . No entanto, são normalmente esquecidos em muitos trabalhos.

A Análise dos Resultados permite obter informação que seja rapidamente assimilável pelo leitor. Por exemplo, se se estivesse a fazer o estudo do movimento de um corpo num plano, seria nesta secção que se relacionavam os valores do espaço percorrido com o tempo, e se verificaria a relação entre um e o outro.

As conclusões permitem, entre outras coisas, verificar se a pessoa que fez o trabalho percebeu, ou não, o que estava a fazer. Uma conclusão errada é o suficiente para invalidar todo um trabalho. Do mesmo modo, um relatório de um trabalho experimental que não apresente quaisquer conclusões tem um valor muito relativo.

Linguagem

A forma como o texto é escrito é também importante para a qualidade do relatório. É falsa a ideia de que, se um trabalho apresenta bons resultados científicos ou é um trabalho bastante avançado, uma linguagem correcta é desnecessária.

A linguagem utilizada deve ser precisa e exacta. (Já agora, como se consegue isso sem um Português correcto?) As frases utilizadas devem ser curtas. Deve-se evitar a utilização da voz passiva, e escrever as frases na voz activa.

Outro aspecto a ter em atenção é o de fornecer tanta informação a-priori quanto possível, antes de descrever uma observação. Deve-se também evitar a utilização de frases encadeadas umas nas outras.

Tabelas, figuras e gráficos

As tabelas permitem uma apresentação ordenada dos valores obtidos no decurso de um trabalho experimental. Os gráficos têm por função condensar a informação contida nos dados numéricos e apresentá-la de uma forma mais facilmente apreensivel.

Referências a tabelas, figuras e gráficos

Um trabalho científico deve ser isento de ambiguidades. Todas as tabelas, gráficos e figuras de um trabalho científico devem estar inequivocamente identificados. A identificação é feita através de um número de ordem e de uma legenda para cada. Deve existir uma numeração independente para cada tipo de elemento (figura, gráfico ou tabela). A legenda deve ser concisa e descrever o conteúdo do elemento respectivo..

Quando se faz no texto alguma referência a um gráfico, tabela ou figura, deve-se sempre indicar qual o número respectivo.

Citações e referências

Utilização de referências

Uma afirmação incluída num texto científico pode ser vista como um de três casos:

• o seu conteúdo é do conhecimento geral;
• o conteúdo da frase é original e resulta do trabalho do autor;
• a frase não é original, mais foi dita por outra pessoa; tem origem noutro trabalho.

No primeiro caso, quando a afirmação é algo do conhecimento geral, não faz sentido o autor justificá-la.

O segundo caso, quando a afirmação é original e resulta do trabalho do autor, é aquele que traz valor a um trabalho. No entanto, uma afirmação original não pode ser incluída sem ser solidamente suportada pelo trabalho desenvolvido e apresentado no texto. Esse suporte experimental confere ao autor a autoridade de afirmar as suas conclusões, que resultam de um processo desenvolvido segundo o método científico.

No terceiro caso, o autor socorre-se de uma outra pessoa para afirmar alguma coisa. Esta atitude não tem nada de incorrecto. Pelo contrário, demonstra que o autor, antes de iniciar o trabalho prático, se dedicou ao estudo do assunto e viu quem já tinha efectuado trabalhos semelhantes. No entanto, deve-se deixar bem explícito que se está a socorrer do trabalho de outrem, que se está a fazer uma citação. Isso é feito através dasreferências. São por demais os exemplos de situações em que há a inclusão, no trabalho assinado por alguém, de extensas partes (quando não citação integral) de trabalhos realizados por outras pessoas, sem qualquer referência ao trabalho original. (Esse é infelizmente o caso de um dos links incluído nesta página...)

De um modo geral, a referência refere-se a citações de trabalho que está descrito nalgum outro lado. Não precisa de ser trabalho efectuado por um autor diferente. Se a justificação para o que se afirma foi feita nalgum outro relatório anterior do autor, por exemplo, este deve pôr o seu trabalho como uma referência. Não precisa de apresentar, por extenso, o fundamento da sua afirmação: indica onde este se encontra.

As referências assumem assim duas funções: identificar o autor de uma afirmação, quando esta não é original, e fornecer os elementos necessários para se aprofundar o estudo de aspectos que não são abordados em profundidade no relatório. Esta segunda função é importantíssima para o desenvolvimento de trabalho científico. Permite a quem lê um artigo saber onde o autor estudou sobre esse assunto e onde pode ir buscar mais informação sobre um assunto específico.

Como indicar as referências

As formas de indicar referências em textos são múltiplas: podem ser feitas com numeração, usando o nome dos autores, etc.. No entanto, todas elas cumprem a mesma função: identificar no texto, de forma resumida, um trabalho que estará descrito, por extenso, numa secção de Bibliografia ou Referências. A escolha é muitas vezes uma questão de gosto pessoal ou conveniência. É comum encontrar referências por número em textos curtos, sendo as referências por sigla de texto mais utilizadas em textos longos. As principais revistas científicas têm definidas as regras para fazer referências, 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 indicação de referências num texto, usa-se geralmente uma das seguintes formas:

• número de ordem ([1], [2], ...)
• sigla com o nome do autor e o ano de publicação.

Na indicação por número, a sequência pode ser pela ordem em que as referência aparecem no texto ou então pela ordem alfabética de referências.

No segundo caso, utiliza-se uma sigla composta, geralmente, a partir do nome do autor ou autores, o ano de publicação e, mais raramente, o título. Por exemplo, podem-se utilizar as primeiras letras do último apelido do autor e o ano de publicação. Por exemplo, um artigo escrito em 1980 por António Silva ficaria [SILVA80] ou [Sil80]. Quando este método gera referências 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 publicação. Por exemplo, um artigo composto por Ana Lamy e José Carlos Malato em 1999 ficaria [LamM99]. Quando o número de autores é muito grande (geralmente, maior do que três ou quatro), as iniciais dos restantes autores são substituídas por um "+".

Em qualquer dos casos, é prática comum indicar a referências entre parênteses rectos ([1] ou [Sil80]). Por vezes, utilizam-se também barras (/1/ ou /Sil80/). Esta última forma, que hoje caiu em desuso, existe apenas para suprir a falta dos parênteses rectos na maioria das máquinas de escrever e deve ser evitada.

No fim do texto, inclui-se a lista das referências. Cada uma é identificada pelo número ou sigla utilizada, e faz-se a identificação completa, com:

• o nome do autor, começando pelo último apelido;
• o título do artigo, escrito entre aspas;
• o nome da revista onde o artigo foi publicado (este nome é escrito em itálico ou, se tal não for possível, sublinhado);
• o volume e o número da revista;
• o editor da revista;
• o local e a data da publicação;
• as páginas do artigo.

Quando um artigo tiver vários autores, indicam-se todos os autores, até um número máximo estipulado. Quando o número de autores for superior a este máximo, indica-se o nome do primeiro e em seguida a expressão et al. (e outros).

A indicação do número e volume da revista pode ser feita em texto (por exemplo, Vol. 35, nº 4). Outras vezes, a indicação do volume e número é abreviada, escrevendo-se o número do volume e, entre parênteses, o número da revista -por exemplo, a revista número 4 do volume 35 é indicada como 35(4).

No caso de livros, a indicação é idêntica, à excepção do título do artigo, que não se aplica.

Hoje em dia existem vários softwares para fazer a gestão de bases de dados bibliográficas e que inclusivé fazem automaticamente a inserção de referências num texto. Para quem usa o processador Latex, o Bibtex é um programa que insere automaticamente as referencias no texto, fazendo a sua numeração e compilação segundo o estilo definido.

Algumas normas avulsas...

• Evitar mencionar problemas de tempo (ou falta dele...), de equipamento ou outros de natureza idêntica.
• Apresentar de forma clara qual o ponto em que o trabalho se encontra na data limite para a sua conclusão, deixando bem claro quais os objectivos que foram cumpridos e quais os que não foram.
• Nos trabalhos que envolvam "software", apresentar documentação de alto nível (não esquecer que há mais modos de representar um programa em alto nível para além do fluxograma)
• Nos trabalhos que envolvam montagens de "hardware", apresentar esquemas dos circuitos utilizados, que descrevem a lógica do funcionamento do circuito e a sua estrutura (não confundir com esquemas de ligações, que são um auxiliar de montagem);
• Apresentar o código do programa convenientemente detalhado, quer ao nível da instrução, quer ao nivel dos blocos do programa (o uso de comentários correctamente colocados pode tornar um programa muito mais fácil de ler)
• Utilizar tipos de letras distintos para o texto de programa e para o código. Reservar para o código um tipo de letra de largura constante (courier, por exemplo) e em tamanho que permita a sua leitura fácil (por ex., tamanho 9 para o tipo courier).