Contributos para a Escrita de um Relatório

Este texto apresenta um conjunto de recomendações para a escrita de um relatório.

• Relatório

  • Um Relatório é um documento técnico que deve esclarecer acerca dos objectivos de uma dada tarefa e dos acontecimentos relevantes ocorridos ao longo da sua execução.
  • Um Relatório deve formular o problema estudado, descrever os métodos utilizados na sua resolução, caracterizar o desempenho dos métodos usados (quando aplicável) e apresentar as conclusões do trabalho.
  • O Relatório deve ser organizado de forma a permitir uma compreensão fácil do trabalho realizado, admitindo-se que o leitor possui conhecimentos básicos mas não conhece o problema estudado.
  • O Relatório deve dar ao leitor, de forma gradual, a informação necessária para a compreensão do problema, dos métodos usados e dos resultados obtidos. Assim, não devem ser usados conceitos que não tenham sido anteriormente definidos (excepto quando são de uso corrente).

• Estrutura

  A estrutura do relatório deve ser a seguinte (começando em páginas separadas, e ímpares):
  • página de capa,contendo instituição, título do trabalho, autores, local e data
  • Índice
  • 1. Introdução
  • 2. Capítulo ...
  • 3. Capítulo ...
  • ...
  • ?. Conclusões
  • A. Anexo ...
  • B. Anexo ...
  • ...

• Conteúdo e estrutura dos capítulos

  • A Introdução deve começar por dar uma perspectiva geral do problema em estudo, e à medida que vai progredindo, deve ir fornecendo informação mais específica, até se abordar a área em concreto tratada no relatório.
  • A estrutura dos capítulos deve ser tal que contenha secções e subsecções de forma equilibrada, cada uma contendo partes relativamente separadas do trabalho. Não criar apenas uma secção (subsecção) dentro de um capítulo (secção).
  • As Conclusões devem conter os principais resultados do trabalho, indicando-se quais os melhores modelos ou técnicas, para além de uma análise crítica das limitações e possíveis direcções de trabalho futuro.
  • Os Anexos contêm informação adicional, que não é fundamental para a compreensão do trabalho, ou que é suplementar ao corpo principal do relatório.

• Geral

  • As siglas devem ser sempre definidas da primeira vez que são usadas no texto.
  • O texto deve ser escrito no tempo presente (excepto quando se relatam experiências ou medidas) e na forma impessoal (e não na primeira pessoa do singular ou do plural). Por exemplo:

    Este texto trata da forma de como se deve escrever um relatório. Ninguém deve ficar ofendido se muitas das sugestões aqui fornecidas são óbvias ou já conhecidas.

  • Evitar escrita telegráfica ou literária, isto é, não usar frases muito curtas ou muito longas, e não utilizar uma forma de escrita pouco técnica.
  • Deve evitar-se usar adjectivos, excepto quando podem ser quantificados.
  • Usar o corrector de ortografia do processador de texto, Spelling, antes de imprimir o texto.
  • Os parágrafos devem ser separados entre si, ou por espaço vertical adicional antes deste ou por espaço adicional horizontal no princípio deste.
  • Ter o cuidado de dar um estilo coerente e uniforme ao relatório.
  • Não usar palavras inglesas quando há uma tradução muito directa e corrente para elas. Escrevê-las em itálico no caso de as usar.
  • As páginas devem ser numeradas centralmente, ou então à direita e à esquerda respectivamente para as páginas ímpares e pares.
  • Não deixar o título de secções ou subsecções isolados no fim de uma página.

• Formato geral

  • O formato do papel deve ser A4.
  • As margens devem ser de 2.5 cm, quer na vertical quer na horizontal.
  • O texto normal deve ser escrito com a fonte Times Roman 12 pt, e uma separação entre linhas de At least 12 pt (equivalente a Single line). Uma fonte maior deve ser usada para títulos de secções e capítulos, com espaço adicional antes e depois destes.
  • A numeração deve começar na folha a seguir à capa.

• Figuras e Tabelas

  • Caso se deseje, pode abreviar-se para Fig. e Tab.
  • As Figuras e as Tabelas devem ser numeradas por capítulo.
  • As Figuras e Tabelas devem vir centradas horizontalmente na página. Espaço adicional deve ser deixado antes e depois das Figuras e Tabelas.
  • A legenda das Figuras deve vir depois destas. A legenda das Tabelas pode vir antes ou depois destas, mas deve ser mantida a coerência em todo o documento.
  • Devem-se colocar as Figuras e as Tabelas no texto só depois de nele virem referenciadas, o que deve acontecer sempre.
  • Quando se referem Figuras e Tabelas no texto, estas não devem vir entre parênteses. Por exemplo:

    Pode observar-se que o decrescimento da potência é monótono, Fig. 3.4.

• Equações e matemática

  • As equações devem ser alinhadas à esquerda, e numeradas por capítulo. Por exemplo:
    (3.4)

    c = f l

  • Os símbolos matemáticos devem ser escritos em fonte itálica.
  • Definir sempre os símbolos depois das equações, na primeira vez que são utilizados.
  • Quando se tem números que ultrapassam os milhares, deve usar-se um espaço para separar os milhares, isto é, deve usar-se 12 345
  • Referir as equações apenas pelo seu número. Por exemplo:

    > deduz-se de (2.30) que não existe variação com a frequência

Antes de imprimir o relatório, verifique se foi escrito de acordo com estas sugestões. Exercite a sua capacidade de auto-crítica antes de dar o texto a ler a alguém.

O presente texto tem como base o documento: Correia, L. M, Contributos para a Escrita de um Relatório, Instituto Superior Técnico, Lisboa, Portugal, 2001 ( http://mega.ist.utl.pt/~leec/tfcs/ContEscRelatorio.pdf )