Como escrever um relatrio

Escola Superior de Tecnologia Universidade do Algarve

Objectivo
Apresentar regras orientadoras para a elaborao dum relatrio.

No uma abordagem exaustiva, mas antes uma viso geral sobre os aspectos fundamentais.

Como escrever o relatrio

Sumrio
1. 2. 3. 4. 5. Funo e importncia do relatrio de projecto Elementos constituintes do relatrio Estilos de redaco e estilos grficos Funcionalidades teis dos processadores de texto Recomendaes

Como escrever o relatrio

Funo do relatrio
O relatrio dum projecto um documento tcnico que descreve um problema e as actividades realizadas para o resolver. Em termos gerais o relatrio deve: Formular o problema estudado; Descrever os mtodos utilizados na sua resoluo; Descreve as possveis opes; Descrever e justificar as opes escolhidas; Apresentar os resultados obtidos; Apresentar as concluses que podem ser inferidas desses resultados.

Como escrever o relatrio

Importncia do relatrio
Faz parte da avaliao Documentao do projecto, contribuio para a criao de conhecimento, apoio a trabalho futuro, Primeira publicao do aluno, parte do seu portfolio,

Como escrever o relatrio

Normas e regras
A elaborao de um relatrio deve seguir regras normalizadas para que se possa garantir uma convergncia de critrios que orientem os procedimentos, quer dos alunos que o realizam, quer dos docentes que os devem orientar e avaliar. As regras orientadoras apresentadas seguem as Normas Portuguesas que se aplicam formatao de documentos tcnicos (IPQ 1968a; IPQ 1968b; IPQ 1969; IPQ 1986a; IPQ 1986b; IPQ 1989a; IPQ 1989b; IPQ 1993a; IPQ 1993b; IPQ 1994; IPQ 1995; IPQ 1998).

Como escrever o relatrio

Estrutura geral de um relatrio

Seces
Capa Pgina de rosto Dedicatria (se existir) Resumo Agradecimentos (se existir) ndice Outros ndices e listas (se existirem) Introduo Outros captulos Concluso Referncias Anexos 405-1, 405-2 113 Elementos ps-textuais Corpo do relatrio 739 739 418 Elementos pr-textuais

NP
738 738

Localizao

Como escrever o relatrio

Capa e pgina de rosto

Capa identifica o ttulo do relatrio, o autor, a escola e a data de concluso. Pgina de rosto contem os dados da Capa e outros dados complementares tais como a identificao dos orientadores, perodo de realizao do projecto, fim a que se destina o relatrio, etc.

Como escrever o relatrio

Exemplo duma capa e pgina de rosto

Ttulo Ttulo Autor Figura Autor
Relatrio submetido como requisito parcial para obteno do grau de licenciado em Engenharia Informtica. Identificao dos orientadores

Instituio Instituio

Data

Data
Como escrever o relatrio

Dedicatria (se existir)

Esta seco apresenta a dedicatria famlia, pai, me, namorada/o, ou alguma outra pessoa ou organizao a quem o autor deseje dedicar o trabalho. Normalmente no existe qualquer ttulo e o texto alinhado direita.

Como escrever o relatrio

Resumo e Palavras-chave
Resumo deve ocupar uma pgina no mximo, incluindo palavraschave se existirem, e deve permita ao leitor ficar com uma ideia precisa e completa do trabalho efectuado e das principais concluses. Palavras-chave seco opcional (na mesma pgina do resumo), com no mximo 6 palavras-chave que estejam directamente relacionadas com o tema do trabalho. A ordem pela qual se escrevem deve ser decrescente relativamente importncia directa com o tema do trabalho. Os ttulos Resumo e Palavras-chave no devem ser numerados.

Como escrever o relatrio

Resumo e Palavras-chave
Abstract - resumo em ingls. Keywords - palavras-chave em ingls.

Como escrever o relatrio

Agradecimentos (se existir)

Seco onde se agradece s pessoas e entidades que de alguma forma contriburam para a realizao do trabalho: famlia, professores, namorado/a, pessoas com quem discutiu ideias, pessoas que forneceram cdigo ou ajudaram de alguma maneira, escola, empresa onde efectuou estgio ou onde trabalha, organizaes que deram bolsas de estudo, etc. Os agradecimentos devem ser directos e especficos, explicitando o contributo de cada uma das pessoas a quem se agradece. O ttulo no deve ser numerado.

Como escrever o relatrio

ndice
Tem como funo listar pormenorizadamente os elementos identificadores do contedo do relatrio (captulos e outras seces), pela ordem que so apresentados no texto e com a respectiva localizao (nmero de pgina). Os ttulos do ndice devem ter o mesmo formato utilizado para os ttulos do texto. Deve ser usada numerao diferente (em romano), para os elementos pr-textuais.

Como escrever o relatrio

Outros ndices e listas

Se o nmero de figuras ou tabelas no for reduzido, conveniente elaborar ndices individuais para esses elementos. tambm conveniente apresentar listas de abreviaturas, smbolos e termos tcnicos, sempre que estes existam em grande nmero.

Como escrever o relatrio

Introduo (primeiro captulo)

No captulo Introduo pretende-se fornecer ao leitor informao suficiente para que este possa compreender os objectivos e o mbito do trabalho desenvolvido. Seces que se espera encontrar no captulo : Enquadramento e motivao Local onde foi realizado o trabalho Descrio do problema Objectivos Estrutura do relatrio

Como escrever o relatrio

Introduo (primeiro captulo)

No captulo Introduo pretende-se fornecer ao leitor informao suficiente para que este possa compreender os objectivos e o mbito do trabalho desenvolvido. Identificar a rea em que se
enquadra o trabalho e o que levou o autor : Seces que se espera encontrar no captulo a fazer o trabalho.

Enquadramento e motivao Local onde foi realizado o trabalho Descrio do problema Objectivos Estrutura do relatrio

Mais do que as motivaes pessoais, deve ser descrita a importncia do tema: interesse cientfico, valor econmico, inexistncia de trabalhos semelhantes, etc.

Como escrever o relatrio

Introduo (primeiro captulo)

No captulo Introduo pretende-se fornecer ao leitor informao suficiente para que este possa compreender os objectivos e o mbito do trabalho desenvolvido. Caso se justifique, descrever muito
sucintamente o local/empresa onde Seces que se espera encontrar no captulo : foi realizado o projecto.

Enquadramento e motivao Local onde foi realizado o trabalho Descrio do problema Objectivos Estrutura do relatrio

Abordar aspectos como: Principais caractersticas da entidade (departamentos, instalaes, histria, etc); Descrio do ambiente envolvente do projecto/estgio (processo a informatizar); Descrio dos meios informticos (recursos para a concretizao do projecto).
Como escrever o relatrio

Introduo (primeiro captulo)

No captulo Introduo pretende-se fornecer ao leitor informao suficiente para que este possa compreender os objectivos e o mbito do trabalho desenvolvido. Descrever detalhadamente qual o
problema que se pretende resolver com o Seces que se espera encontrar no captulo :trabalho.

Enquadramento e motivao Local onde foi realizado o trabalho Descrio do problema Objectivos Estrutura do relatrio

Normalmente o problema definido atravs da identificao e definio de subproblemas. Por exemplo, se o problema consistir no desenvolvimento de uma aplicao informtica, os subproblemas podem ser a anlise do sistema, o desenvolvimento de determinados algoritmos, a implementao de uma base de dados, etc.
Como escrever o relatrio

Introduo (primeiro captulo)

No captulo Introduo pretende-se fornecer ao leitor informao suficiente para que este possa compreender os objectivos e o mbito do trabalho desenvolvido. Os detalhes do problema so
convertidos em objectivos concretos de pesquisa e desenvolvimento. Seces que se espera encontrar no captulo :

Enquadramento e motivao Local onde foi realizado o trabalho Descrio do problema Objectivos Estrutura do relatrio

Um objectivo consiste num fim concreto que se pretende atingir. No contexto mais comum dos projectos/estgios de alunos de Engenharia Informtica, que consiste normalmente na produo de software, os objectivos correspondem aos contributos que se espera obter com a utilizao do software implementado.
Como escrever o relatrio

Introduo (primeiro captulo)

No captulo Introduo pretende-se fornecer ao leitor informao suficiente para que este possa compreender os objectivos e o mbito do trabalho desenvolvido. Seces que se espera encontrar no captulo : Enquadramento e motivao Local onde foi realizado o trabalho Descrever sumariamente, num nico Descrio do problema pargrafo, o contedo dos restantes captulos do relatrio. Objectivos Estrutura do relatrio

Como escrever o relatrio

Introduo (primeiro captulo)

O captulo Introduo dever dar resposta s seguintes questes: Qual o problema? Porque importante? Quais so os objectivos que se pretende alcanar? De que maneira se pretende alcanar esses objectivos? Como est organizado o resto do relatrio?

Como escrever o relatrio

Outros captulos
Para alm dos captulos Introduo e Concluso, os restantes captulos constituem a descrio detalhada do trabalho desenvolvido pelo aluno. A estruturao desta descrio depender da linha de raciocnio seguida e das actividades realizadas pelo aluno, mas genericamente podemos considerar a seguinte estrutura (captulos): Estado do conhecimento; Anlise do sistema; Implementao; Avaliao.

Como escrever o relatrio

Outros captulos
Para alm dos captulos Introduo e Concluso, os restantes captulos constituem a descrio detalhada do trabalho desenvolvido pelo aluno. A estruturao desta descrio depender da linha de raciocnio seguida e das actividades realizadas pelo aluno, mas genericamente podemos considerar a seguinte estrutura (captulos): Estado do conhecimento; Anlise do sistema; Implementao; Avaliao.
Apresentao dos mtodos, ferramentas e conhecimentos que se aplicam ao(s) problema(s) e que contribuem para a construo da(s) soluo(es). Ser conveniente indicar o problema alvo de cada mtodo, ferramenta ou conhecimento aplicado, justificando assim o contedo da sua apresentao. Descrio dos detalhes tcnicos e conceitos que permitem a um indivduo leigo na matria a compreenso da abordagem adoptada na resoluo do(s) problema(s). Descrio sumria de solues j existentes.
Como escrever o relatrio

Outros captulos
Para alm dos captulos Introduo e Concluso, os restantes captulos constituem a descrio detalhada do trabalho desenvolvido pelo aluno. A estruturao desta descrio depender da linha de raciocnio seguida e das actividades realizadas pelo aluno, mas genericamente podemos considerar a seguinte estrutura (captulos): Estado do conhecimento; Anlise do sistema; Implementao; Avaliao.
Anlise das especificaes do problema; identificao das entidades e das suas relaes, dos fluxos de dados, definio de interfaces, especificao de storyboards, etc. Desenvolvimento do modelo para resoluo do problema.

Como escrever o relatrio

Outros captulos
Para alm dos captulos Introduo e Concluso, os restantes captulos constituem a descrio detalhada do trabalho desenvolvido pelo aluno. A estruturao desta descrio depender da linha de raciocnio seguida e das actividades realizadas pelo aluno, mas genericamente podemos considerar a seguinte estrutura (captulos): Estado do conhecimento; Anlise do sistema; Implementao; Avaliao.

Implementao do modelo desenvolvido, num sistema computacional. Descrio concisa do hardware e do software utilizado.

Como escrever o relatrio

Outros captulos
Para alm dos captulos Introduo e Concluso, os restantes captulos constituem a descrio detalhada do trabalho desenvolvido pelo aluno. A estruturao desta descrio depender da linha de raciocnio seguida e das actividades realizadas pelo aluno, mas genericamente podemos considerar a seguinte estrutura (captulos): Estado do conhecimento; Anlise do sistema; Implementao; Avaliao.

Breve descrio de como instalar, usar ou aceder ao sistema desenvolvido. Se a descrio for extensa, considerar a sua localizao num anexo ou mesmo num volume parte. Descrio dos testes realizados e os resultados experimentais obtidos; anlise critica dos resultados; comparao dos resultados com os obtidos por outros autores.
Como escrever o relatrio

Concluso (ltimo captulo)

Na Concluso so analisados os resultados luz do exposto na Introduo. Deve conter uma sntese do trabalho, com os resultados mais importantes e a sua relao com os objectivos propostos e com os meios usados. A concluso geral do trabalho deve apresentar recomendaes e sugestes, resultantes do trabalho realizado, sempre que tal se aplicar. Deve tambm apresentar sugestes para a continuao do trabalho. Se o trabalho for de grande dimenso conveniente sistematizar as concluses para cada parte e, por fim, analisar o conjunto e a relao entre as partes.

Como escrever o relatrio

Concluso (ltimo captulo)

A Concluso deve dar resposta as seguintes questes: Em que medida os objectivos foram alcanados? Quais foram as lies aprendidas? Quais so as ideias para trabalhos futuros? Quais so as vantagens e desvantagens da soluo apresentada, face a outras j existentes?

Como escrever o relatrio

Referncias
Esta seco lista as referncias bibliogrficas citadas no texto. Dever haver citao de uma referncia sempre que se utilizem ideias, conhecimentos ou mtodos que no so da nossa autoria. As referncias no devem incluir documentos que no foram citados no texto. Caso existam, devem ser descritos na seco Bibliografia. Os itens da lista de referncias so normalmente ordenados segundo o seu aparecimento no texto e a ordem identificada por um nmero entre parnteses.

Como escrever o relatrio

Referncias (norma portuguesa)

A norma portuguesa para referncias bibliogrficas est harmonizada com a norma ISO 690 e define estilos para diferentes tipos de documentos: NP 405-1 Documentos impressos NP 405-2 Material no livro NP 405-3 e NP 405-4 Documentos no publicados e documentos electrnicos. A norma NP 405 define 3 formas alternativas de citao: autor-data, citao-nota e citao numrica.

www.ipq.pt
Como escrever o relatrio

Referncias (norma portuguesa)

Livro

SILVA, Maria Cardeira da Um Islo prtico: o quotidiano feminino em meio popular muulmano. Oeiras : Celta, 1999. ISBN 972-774-027-8.
Captulo

KANO, Takayoshi The bonobos peaceable kingdom. In CIOCHON, Russell L. ; NISBETT, Richard A., eds. The primate anthology. New Jersey : Prentice-Hall, 1998. ISBN 0-13-613845-4. p. 66-73.
Artigo

REEVES, Emer P., [et al.] Killing of neutrophilis is mediated trough activation of proteases by K+ flux. Nature. London : Macmillan. ISBN 0028-0836. 416:6878 (2002) 291-297.
Documento electrnico

COLUMBIA UP Basic CGOS style [Em linha]. New York : Columbia Univ., [1999], actual. 20 Mar. 2000. [Consult. 5 Jan. 2002]. Disponivel na WWW: URL:http//www.columbia.edu/cu/cup/cgos/idx_basic.html.
Como escrever o relatrio

Referncias (norma portuguesa)

Citaes numricas

(1) SILVA, Maria Cardeira da Um Islo prtico: o quotidiano feminino em meio popular muulmano. Oeiras : Celta, 1999. ISBN 972-774-027-8. (2) KANO, Takayoshi The bonobos peaceable kingdom. In CIOCHON, Russell L. ; NISBETT, Richard A., eds. The primate anthology. New Jersey : Prentice-Hall, 1998. ISBN 0-13-613845-4. p. 66-73. (3) REEVES, Emer P., [et al.] Killing of neutrophilis is mediated trough activation of proteases by K+ flux. Nature. London : Macmillan. ISBN 0028-0836. 416:6878 (2002) 291-297. (4) COLUMBIA UP Basic CGOS style [Em linha]. New York : Columbia Univ., [1999], actual. 20 Mar. 2000. [Consult. 5 Jan. 2002]. Disponivel na WWW: URL:http//www.columbia.edu/cu/cup/cgos/idx_basic.html.

Como escrever o relatrio

Referncias (norma portuguesa)

Citao autor-data
sabido que 1013 clculos por segundo produzem o efeito de cerca de 1011 neurnios (Moravec, 1992, p. 243), o que atribui a cada neurnio 100 clculos por segundo.

Citao autor-data com o nome do autor no texto

Segundo Hans Moravec, um neurnio executa 100 clculos por segundo, tendo em conta que 1013 clculos por segundo produzem o efeito de cerca de 1011 neurnios (1992, p. 243).

Citao-nota
sabido que 1013 clculos por segundo produzem o efeito de cerca de 1011 neurnios 1, o que atribui a cada neurnio 100 clculos por segundo. ... ______________________ 1 MORAVEC, Hans Homens e Robots, p. 243.

Citao numrica
Hans Moravec refere que 1013 clculos por segundo produzem o efeito de cerca de 1011 neurnios (8), o que atribui a cada neurnio 100 clculos por segundo.
Como escrever o relatrio

Referncias (norma APA)

A American Psychological Association (APA) definiu um estilo de escrita para textos cientficos e uma norma para referncias bibliogrficas que so conhecidos e usados em todo o mundo por serem simples.

www.apastyle.com

Como escrever o relatrio

Referncias (norma APA)

Livro

Bastos, S. P. (1997). O Estado Novo e os seus vadios: contribuio para o estudo das identidades marginais e da sua represso. Portugal de Perto. Lisboa: D. Quixote.
Captulo

Silva, M. C. (1996) O suq das vaidades: Escolhas e performances corporais femininas em Marrocos. In M. V. de Almeida (Org.), Corpo presente: Treze reflexes antropolgicas sobre o corpo (pp. 54-71). Oeiras: Celta.
Artigo

Page, E. et al. (1968). The use of the computer in analyzing student essays. International Review of Education, 14, 253-263.
Documento electrnico

Gordon, C. H., Simmons, P. & Wynn, G. (2001). Plagiarism: what it is, and how to void it. Consultado em 12 de Dezembro de 2001, em Univ. de British Columbia: http://www.zoology.ubc.ca/bpg/plagiarism.
Como escrever o relatrio

Referncias (norma APA)

Citao de autor nico
1013 clculos por segundo produzem o efeito de cerca de 1011 neurnios (Moravec, 1992).

Citao de autor nico com o nome do autor no texto

Segundo Moravec, um neurnio executa 100 clculos por segundo, tendo em conta que 1013 clculos por segundo produzem o efeito de cerca de 1011 neurnios (1992).

Citao com dois autores

A migrao tende a reduzir a diferenciao gentica entre grupos que trocam indivduos e genes (Melnick & Pearl, 1987, p. 133).

Como escrever o relatrio

Anexos
So documentos, produzidos ou no pelo autor, que surgem aps o texto para introduzirem informao complementar ou afim ao assunto abordado no relatrio. Cada anexo deve ser identificado pela palavra Anexo, seguida de uma letra maiscula a comear em A. A paginao dos anexos deve ser consecutiva e continuar a paginao do texto principal.

Como escrever o relatrio

Estilo da redaco
A escrita deve ser impessoal. No devem ser utilizadas formas enfticas, como ponto de exclamao ou reticncias. No devem ser usadas frases muito longas. O texto deve ter um encadeamento lgico e ser coeso. A utilizao de referncias a outras partes do relatrio refora a coeso do mesmo. Um termo deve ser sempre definido quando utilizado pela primeira vez. As citaes e referncias bibliogrficas devem ser feitas de acordo com normas prprias. As citaes devem ser fieis. Se se eliminar alguma poro do texto, isso deve ser indicado com reticncias (). Todas as figuras, tabelas e frmulas devem ser referenciadas no texto. A primeira referncia deve aparecer o mais perto possvel do correspondente elemento. Os ttulos de captulos devem aparecer no incio de uma nova pgina. Os ttulos das seces no devem estar muito perto do fim da pgina ou ter poucas linhas entre o incio da pgina e eles prprios.

Como escrever o relatrio

Estilo grfico (formato geral)

Formato A4 Papel branco 80g/m2 Margem superior de 2,5 cm

Fonte Times New Roman Tamanho 12 Espaamento entre linhas de 1,5 linhas

Espaamento de 6pt antes e 12pt depois

Margem esquerda de 3 cm Margem direita de 2 cm

Numerao rabe No rodap e alinhada direita Margem inferior de 2,5 cm

Como escrever o relatrio

Estilo grfico (ttulos)

Times New Roman 24 + Bold Espaamento: 18 Antes, 12 Depois

Times New Roman 16 + Bold Espaamento: 18 Antes, 12 Depois

Times New Roman 13 + Bold Espaamento: 18 Antes, 12 Depois

Como escrever o relatrio

Estilo grfico (figuras)

Centrada e a cores se necessrio

Identificao do captulo

Espaamento constante

Posicionada a seguir, concisa, com ref. bibliogrfica se necessrio Referenciada no texto

Como escrever o relatrio

Estilo grfico (tabelas)

Referenciada no texto Centrada e a cores se necessrio

Posicionada antes, com identificao do captulo

Espaamento constante

Como escrever o relatrio

Estilo grfico (frmulas)

Numeradas de forma simples, ou com identificao do captulo a que pertencem

Descrio das variveis sempre que necessrio

Espaamento constante

Referenciadas no texto,

Como escrever o relatrio

Processador de texto
Algumas funcionalidades muito teis: Construo automtica do ndice Numerao automtica de tabelas, figuras, equaes, etc. Referncias cruzadas Notas de rodap Cabealhos e rodaps diferenciados Numerao de pginas Organizao das referncias bibliogrficas Construo do ndice remissivo

Como escrever o relatrio

Sugesto para quem no gosta de escrever relatrios

Contar a histria apenas com figuras e tabelas, depois acrescentar texto para descrever esses elementos e por fim acrescentar texto para ligar as vrias partes.

Como escrever o relatrio

Recursos

teses.mediateca.info w3.ualg.pt/~lnunes/Textosdeapoio/normas.PDF

Como escrever o relatrio

Recomendaes finais
No deixar o relatrio para o fim! No deixar o relatrio para o fim!!! No deixar o relatrio para o fim!!!!!!!!!!!!!!!!!! Elaborar o relatrio ao longo do projecto em colaborao com o professor orientador. Organizar as referncias bibliogrficas medida que vo aparecendo. No menosprezar nenhuma das partes do relatrio, sobretudo as que descrevem o trabalho desenvolvido! Contar a histria com figuras e tabelas educativas. Usar as potencialidades dos modernos processadores de texto. Ler relatrios de referncia de anos anteriores. Anexar uma cpia em suporte digital do prottipo desenvolvido. Escolher uma encadernao profissional. No deixar o relatrio para o fim!!!!!!!!!!!!!!!!!!

Como escrever o relatrio