ESCREVER UM RELATÓRIO CIENTÍFÍCO: DAS PARTES PARA O TODO

Transcrição

1 ESCREVER UM RELATÓRIO CIENTÍFÍCO: DAS PARTES PARA O TODO por Helena Sofia V. Cardoso Machado Departamento de Engenharia Informática Universidade de Coimbra 3030 Coimbra, Portugal Resumo: Apresentam-se, de forma sintética, os principais cuidados a ter na escrita de um relatório. Para esse efeito, descrevem-se e comentam-se, sequencialmente, as sucessivas componentes de um documento desta natureza. A abordagem seguida poderá constituir um bom auxiliar para os autores que pretendam reforçar a coerência e adequação dos seus relatórios, nomeadamente quando, durante a escrita, lhes surjam dúvidas sobre o que colocar em cada uma das partes do texto. Palavras-chave: Comunicação profissional, escrita de relatórios. 1. INTRODUÇÃO Um relatório desempenha um papel fundamental na transmissão escrita a outrem do conhecimento adquirido, dos dados experimentais medidos, ou da análise comparativa de resultados. Num curso de engenharia, é um elemento de registo precioso para o estudante porque permite a sua consulta posterior para o estudo de um dado tema. É útil para o professor porque permite avaliar os conhecimentos adquiridos e eventualmente corrigir a forma de ensino de temas que detecte não tenham sido devidamente apreendidos. Um bom relatório de engenharia deve seguir um conjunto de regras de forma a torná-lo legível e compreensível, quer para o docente que o vai avaliar (se se tratar de um relatório escolar), quer para um superior que numa empresa o vai consultar. Um relatório de engenharia apresenta um formato mais ou menos normalizado onde se incluem diversas secções que apresentam os objectivos, se faz uma introdução teórica, se apresentam os resultados experimentais e se discutem os resultados. 1

2 2. ESTRUTURA DE UM RELATÓRIO Existem diversos tipos de relatórios em engenharia, que variam de acordo com a função do relatório e com o tipo de actividade que se pretende relatar. Um relatório de engenharia contem, pela ordem indicada, algumas secções abaixo indicadas: Elementos Pré-textuais Capa A página de rosto Resumo analítico Índice Quadro 2-1. Elementos pré-textuais Elemento pré-textual Obrigatório Títulos alternativos Capa Página de rosto Resumo Resumo analítico Agradecimentos (e/ou) Dedicatória Índice Geral Índice de Matérias Índice de Figuras Lista de Figuras Índice de Quadros Lista de Quadros Siglas e Abreviaturas (ou) Glossário Errata Capa A capa de um trabalho científico deve conter os seguintes elementos: a) Nomes dos autores; b) Editores literários ou compiladores; c) Título; d) Número da edição, salvo se for a primeira; e) Número do volume, numa obra de vários volumes; f) Local de publicação; g) Editores; h) Ano de publicação; 2

3 Deve ser estruturada de forma a facilitar a leitura rápida. Página de rosto A página de rosto deve conter toda a informação presente na capa, e ainda: i) Título da língua original (apenas no caso de traduções); j) Nome de outros intervenientes na publicação; k) Título da colecção ou série e respectivo número; l) Colectividade sob o patrocínio da qual a obra é publicada; m) Número internacional normalizado do livro (caso contenha ISBN); n) Número de depósito legal (se aplicável). Se não houver outra informação a acrescentar em relação à da capa, a página de rosto é redundante, mas são excluídas figuras, desenhos e outros elementos decorativos. O papel deve ser igual ao utilizado no resto do trabalho. Resumo Analítico O resumo é identificado com cabeçalho não numerado. Deve conter uma síntese de todo o trabalho, destacando os pontos essenciais. No entanto pode dar especial relevo aos aspectos inovadores e às conclusões, na perspectiva de mostrar claramente o cumprimento dos objectivos. Deve conter a informação necessária a fim de permitir ao leitor descobrir se o conteúdo tem interesse. deve exceder as 500 palavras. Índice O Índice é identificado com cabeçalho não numerado. São apresentadas de forma ordenada as principais divisões do trabalho, nomeadamente a sua divisão por capítulos, com indicação do número da página. O formato do Índice é livre, mas deve ser coerente com a formatação do resto do trabalho. Todos os elementos pré-textuais (com excepção da capa e da página de rosto), capítulos do corpo do texto, e elementos pós-textuais devem constar do Índice. Sempre que haja necessidade de dividir o trabalho em volumes, o Índice do trabalho e o Índice referente ao conteúdo do volume deve constar em todos os volumes. 3

4 Corpo do trabalho Introdução Desenvolvimento Conclusão Introdução Deve ser considerada aqui a Introdução como um elemento genérico do trabalho, e não como o título de um capítulo. Na realidade a parte introdutória pode ser composta pela apresentação do problema e da necessidade do trabalho, pela identificação dos objectivos do trabalho, e até pela revisão do estado do conhecimento. Estes tópicos podem, ou não, dar origem a capítulos individualizados. Esta divisão depende da necessidade que o autor sentir na estruturação dos tópicos. Aconselha-se a que estes tópicos sejam divididos por capítulos uma vez que ajudam a clarificar a leitura e facilitam a consulta. Desenvolvimento O Desenvolvimento compreende os capítulos em que são explicados os métodos e é feita a análise de resultados (eventualmente de alternativas). Conclusão Na Conclusão são analisados os resultados à luz do exposto na Introdução. Deve conter uma síntese do trabalho, com os resultados mais importantes e a sua relação com os objectivos propostos e com os meios usados. A conclusão geral do trabalho deve apresentar recomendações e sugestões, resultantes do trabalho realizado, sempre que tal se aplicar. Se o trabalho for de grandes dimensões é conveniente sistematizar as conclusões para cada parte, e por fim analisar o conjunto e a relação entre as partes. 4

5 Elementos Pós-textuais Referencias bibliográficas Bibliografia Anexos Ficha técnica Índice remissivo Quadro 2-2. Elementos pós-textuais Elemento pós-textual Referências Bibliográficas Bibliografia Ficha Técnica Índice Remissivo Anexos Obrigatório Referências bibliográficas Toda a bibliografia consultada deve ser expressamente referida. Deve conter a lista do(s) autor(es), título do artigo ou livro, nome da revista ou da editora do livro, número de páginas e data. As referências usadas podem ser indicadas no texto com um número identificativo. Nas duas referências seguintes exemplifica-se uma forma possível para as referências de livro (o título em itálico) [1] e para revista (o título entre aspas) [2]. [1] Albert Helfrick, William Cooper, Modern Electronic Instrumentation and Measurement Techniques, Prentice-Hall International Editions, [2] J. Canny, "A Computational Approach to Edge Detection", IEEE Trans. On Pattern Analysis and Machine Intelligence, vol. PAMI-8, no. 6, pp ,

6 Bibliografia A Bibliografia é identificada com cabeçalho numerado. Incluem-se na bibliografia as obras consultadas mas não citadas. A formatação deve ser igual à usada nas Referências Bibliográficas. Índice Remissivo O Índice Remissivo é identificado com cabeçalho não numerado. Consiste na lista ordenada alfabeticamente de palavras-chave com indicação da página onde a matéria é tratada, ou onde se utiliza o termo. É usada principalmente em livros. 3. CONCLUSÓES Pretendeu-se sobretudo apresentar algumas das questões mais importantes em torno da escrita de relatórios científico/técnico e dar algumas linhas mestras para orientar na escrita de um texto científico. Para satisfazer este objectivo, optou-se por uma descrição sequencial e pormenorizada dos pontos mais relevantes para a escrita deste tipo de relatórios. Pensa-se que o resultado obtido satisfaz os requisitos de objectividade e a pequena/média dimensão que se pretendia atingir. 4. REFERÊNCIAS - Acetatos da cadeira de Comunicação Técnica e Profissional, 2002/ Voltar 6