Como.escrever.um.relatório

8.456 visualizações

Publicada em

0 comentários
1 gostou
Estatísticas
Notas
  • Seja o primeiro a comentar

Sem downloads
Visualizações
Visualizações totais
8.456
No SlideShare
0
A partir de incorporações
0
Número de incorporações
2
Ações
Compartilhamentos
0
Downloads
96
Comentários
0
Gostaram
1
Incorporações 0
Nenhuma incorporação

Nenhuma nota no slide

Como.escrever.um.relatório

  1. 1. Como escrever um relatórioEscola Superior de TecnologiaUniversidade do Algarve
  2. 2. ObjectivoApresentar regras orientadoras para aelaboração dum relatório.Não é uma abordagem exaustiva, mas antesuma visão geral sobre os aspectosfundamentais.Como escrever o relatório
  3. 3. Sumário1. Função e importância do relatório de projecto2. Elementos constituintes do relatório3. Estilos de redacção e estilos gráficos4. Funcionalidades úteis dos processadores de texto5. RecomendaçõesComo escrever o relatório
  4. 4. Função do relatórioO relatório dum projecto é um documento técnico quedescreve um problema e as actividades realizadas para o resolver.Em termos gerais o relatório deve:• Formular o problema estudado;• Descrever os métodos utilizados na sua resolução;• Descreve as possíveis opções;• Descrever e justificar as opções escolhidas;• Apresentar os resultados obtidos;• Apresentar as conclusões que podem ser inferidas desses resultados.Como escrever o relatório
  5. 5. Importância do relatórioFaz parte da avaliaçãoDocumentação do projecto, contribuição para a criação de conhecimento,apoio a trabalho futuro, …Primeira publicação do aluno, parte do seu portfolio, …Como escrever o relatório
  6. 6. Normas e regrasA elaboração de um relatório deve seguir regras normalizadas para quese possa garantir uma convergência de critérios que orientem osprocedimentos, quer dos alunos que o realizam, quer dos docentes queos devem orientar e avaliar.As regras orientadoras apresentadas seguem as Normas Portuguesasque se aplicam à formatação de documentos técnicos (IPQ 1968a; IPQ1968b; IPQ 1969; IPQ 1986a; IPQ 1986b; IPQ 1989a; IPQ 1989b; IPQ1993a; IPQ 1993b; IPQ 1994; IPQ 1995; IPQ 1998).Como escrever o relatório
  7. 7. Estrutura geral de um relatórioComo escrever o relatório113405-1, 405-2739739418738738NPAnexosElementos pós-textuaisReferênciasConclusãoOutros capítulos Corpo do relatórioIntroduçãoOutros índices e listas (se existirem)ÍndiceAgradecimentos (se existir)ResumoDedicatória (se existir)Página de rostoElementos pré-textuaisCapaLocalizaçãoSecções
  8. 8. Capa e página de rostoCapa – identifica o título do relatório, o autor, a escola e a data deconclusão.Página de rosto – contem os dados da Capa e outros dadoscomplementares tais como a identificação dos orientadores, período derealização do projecto, fim a que se destina o relatório, etc.Como escrever o relatório
  9. 9. Exemplo duma capa e página de rostoComo escrever o relatórioTítuloFiguraAutorInstituiçãoDataTítuloAutorRelatório submetidocomo requisito parcialpara obtenção do graude licenciado emEngenharia Informática.Identificação dosorientadoresInstituiçãoData
  10. 10. Dedicatória (se existir)Esta secção apresenta a dedicatória à família, pai, mãe, namorada/o, oualguma outra pessoa ou organização a quem o autor deseje dedicar otrabalho.Normalmente não existe qualquer título e o texto é alinhado à direita.Como escrever o relatório
  11. 11. Resumo e Palavras-chaveResumo – deve ocupar uma página no máximo, incluindo palavras-chave se existirem, e deve permita ao leitor ficar com uma ideia precisa ecompleta do trabalho efectuado e das principais conclusões.Palavras-chave – secção opcional (na mesma página do resumo), comno máximo 6 palavras-chave que estejam directamente relacionadas como tema do trabalho. A ordem pela qual se escrevem deve ser decrescenterelativamente à importância directa com o tema do trabalho.Os títulos Resumo e Palavras-chave não devem ser numerados.Como escrever o relatório
  12. 12. Resumo e Palavras-chaveAbstract - resumo em inglês.Keywords - palavras-chave em inglês.Como escrever o relatório
  13. 13. Agradecimentos (se existir)Secção onde se agradece às pessoas e entidades que de alguma formacontribuíram para a realização do trabalho: família, professores,namorado/a, pessoas com quem discutiu ideias, pessoas que forneceramcódigo ou ajudaram de alguma maneira, escola, empresa onde efectuouestágio ou onde trabalha, organizações que deram bolsas de estudo, etc.Os agradecimentos devem ser directos e específicos, explicitando ocontributo de cada uma das pessoas a quem se agradece.O título não deve ser numerado.Como escrever o relatório
  14. 14. ÍndiceTem como função listar pormenorizadamente os elementosidentificadores do conteúdo do relatório (capítulos e outras secções), pelaordem que são apresentados no texto e com a respectiva localização(número de página).Os títulos do índice devem ter o mesmo formato utilizado para os títulosdo texto.Deve ser usada numeração diferente (em romano), para os elementospré-textuais.Como escrever o relatório
  15. 15. Outros índices e listasSe o número de figuras ou tabelas não for reduzido, é convenienteelaborar índices individuais para esses elementos.É também conveniente apresentar listas de abreviaturas, símbolos etermos técnicos, sempre que estes existam em grande número.Como escrever o relatório
  16. 16. Introdução (primeiro capítulo)No capítulo Introdução pretende-se fornecer ao leitor informaçãosuficiente para que este possa compreender os objectivos e o âmbito dotrabalho desenvolvido.Secções que se espera encontrar no capítulo :• Enquadramento e motivação• Local onde foi realizado o trabalho• Descrição do problema• Objectivos• Estrutura do relatórioComo escrever o relatório
  17. 17. Introdução (primeiro capítulo)No capítulo Introdução pretende-se fornecer ao leitor informaçãosuficiente para que este possa compreender os objectivos e o âmbito dotrabalho desenvolvido.Secções que se espera encontrar no capítulo :• Enquadramento e motivação• Local onde foi realizado o trabalho• Descrição do problema• Objectivos• Estrutura do relatórioComo escrever o relatórioIdentificar a área em que seenquadra o trabalho e o que levou oautor a fazer o trabalho.Mais do que as motivações pessoais,deve ser descrita a importância dotema: interesse científico, valoreconómico, inexistência de trabalhossemelhantes, etc.
  18. 18. Introdução (primeiro capítulo)No capítulo Introdução pretende-se fornecer ao leitor informaçãosuficiente para que este possa compreender os objectivos e o âmbito dotrabalho desenvolvido.Secções que se espera encontrar no capítulo :• Enquadramento e motivação• Local onde foi realizado o trabalho• Descrição do problema• Objectivos• Estrutura do relatórioComo escrever o relatórioCaso se justifique, descrever muitosucintamente o local/empresaonde foi realizado o projecto.Abordar aspectos como:• Principais características daentidade (departamentos,instalações, história, etc);• Descrição do ambienteenvolvente do projecto/estágio(processo a informatizar);• Descrição dos meios informáticos(recursos para a concretização doprojecto).
  19. 19. Introdução (primeiro capítulo)No capítulo Introdução pretende-se fornecer ao leitor informaçãosuficiente para que este possa compreender os objectivos e o âmbito dotrabalho desenvolvido.Secções que se espera encontrar no capítulo :• Enquadramento e motivação• Local onde foi realizado o trabalho• Descrição do problema• Objectivos• Estrutura do relatórioComo escrever o relatórioDescrever detalhadamente qual é oproblema que se pretende resolvercom o trabalho.Normalmente o problema é definidoatravés da identificação e definiçãode subproblemas. Por exemplo, se oproblema consistir nodesenvolvimento de uma aplicaçãoinformática, os subproblemas podemser a análise do sistema, odesenvolvimento de determinadosalgoritmos, a implementação de umabase de dados, etc.
  20. 20. Introdução (primeiro capítulo)No capítulo Introdução pretende-se fornecer ao leitor informaçãosuficiente para que este possa compreender os objectivos e o âmbito dotrabalho desenvolvido.Secções que se espera encontrar no capítulo :• Enquadramento e motivação• Local onde foi realizado o trabalho• Descrição do problema• Objectivos• Estrutura do relatórioComo escrever o relatórioOs detalhes do problema sãoconvertidos em objectivos concretosde pesquisa e desenvolvimento.Um objectivo consiste num fimconcreto que se pretende atingir. Nocontexto mais comum dosprojectos/estágios de alunos deEngenharia Informática, queconsiste normalmente na produçãode software, os objectivoscorrespondem aos contributos quese espera obter com a utilização dosoftware implementado.
  21. 21. Introdução (primeiro capítulo)No capítulo Introdução pretende-se fornecer ao leitor informaçãosuficiente para que este possa compreender os objectivos e o âmbito dotrabalho desenvolvido.Secções que se espera encontrar no capítulo :• Enquadramento e motivação• Local onde foi realizado o trabalho• Descrição do problema• Objectivos• Estrutura do relatórioComo escrever o relatórioDescrever sumariamente, num únicoparágrafo, o conteúdo dos restantescapítulos do relatório.
  22. 22. Introdução (primeiro capítulo)O capítulo Introdução deverá dar resposta às seguintes questões:Qual é o problema?Porque é importante?Quais são os objectivos que se pretende alcançar?De que maneira se pretende alcançar esses objectivos?Como está organizado o resto do relatório?Como escrever o relatório
  23. 23. Outros capítulosPara além dos capítulos Introdução e Conclusão, os restantes capítulosconstituem a descrição detalhada do trabalho desenvolvido pelo aluno.A estruturação desta descrição dependerá da linha de raciocínio seguidae das actividades realizadas pelo aluno, mas genericamente podemosconsiderar a seguinte estrutura (capítulos):• Estado do conhecimento;• Análise do sistema;• Implementação;• Avaliação.Como escrever o relatório
  24. 24. Outros capítulosPara além dos capítulos Introdução e Conclusão, os restantes capítulosconstituem a descrição detalhada do trabalho desenvolvido pelo aluno.A estruturação desta descrição dependerá da linha de raciocínio seguidae das actividades realizadas pelo aluno, mas genericamente podemosconsiderar a seguinte estrutura (capítulos):• Estado do conhecimento;• Análise do sistema;• Implementação;• Avaliação.Como escrever o relatórioApresentação dos métodos, ferramentas econhecimentos que se aplicam ao(s)problema(s) e que contribuem para aconstrução da(s) solução(ões). Seráconveniente indicar o problema alvo de cadamétodo, ferramenta ou conhecimento aplicado,justificando assim o conteúdo da suaapresentação. Descrição dos detalhestécnicos e conceitos que permitem a umindivíduo leigo na matéria a compreensão daabordagem adoptada na resolução do(s)problema(s). Descrição sumária de soluções jáexistentes.
  25. 25. Outros capítulosPara além dos capítulos Introdução e Conclusão, os restantes capítulosconstituem a descrição detalhada do trabalho desenvolvido pelo aluno.A estruturação desta descrição dependerá da linha de raciocínio seguidae das actividades realizadas pelo aluno, mas genericamente podemosconsiderar a seguinte estrutura (capítulos):• Estado do conhecimento;• Análise do sistema;• Implementação;• Avaliação.Como escrever o relatórioAnálise das especificações do problema;identificação das entidades e das suasrelações, dos fluxos de dados, definição deinterfaces, especificação de storyboards, etc.Desenvolvimento do modelo para resolução doproblema.
  26. 26. Outros capítulosPara além dos capítulos Introdução e Conclusão, os restantes capítulosconstituem a descrição detalhada do trabalho desenvolvido pelo aluno.A estruturação desta descrição dependerá da linha de raciocínio seguidae das actividades realizadas pelo aluno, mas genericamente podemosconsiderar a seguinte estrutura (capítulos):• Estado do conhecimento;• Análise do sistema;• Implementação;• Avaliação.Como escrever o relatórioImplementação do modelo desenvolvido, numsistema computacional. Descrição concisa dohardware e do software utilizado.
  27. 27. Outros capítulosPara além dos capítulos Introdução e Conclusão, os restantes capítulosconstituem a descrição detalhada do trabalho desenvolvido pelo aluno.A estruturação desta descrição dependerá da linha de raciocínio seguidae das actividades realizadas pelo aluno, mas genericamente podemosconsiderar a seguinte estrutura (capítulos):• Estado do conhecimento;• Análise do sistema;• Implementação;• Avaliação.Como escrever o relatórioBreve descrição de como instalar, usar ouaceder ao sistema desenvolvido. Se adescrição for extensa, considerar a sualocalização num anexo ou mesmo numvolume à parte. Descrição dos testesrealizados e os resultados experimentaisobtidos; análise critica dos resultados;comparação dos resultados com osobtidos por outros autores.
  28. 28. Conclusão (último capítulo)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 asua 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.Deve também apresentar sugestões para a continuação do trabalho.Se o trabalho for de grande dimensão é conveniente sistematizar as conclusõespara cada parte e, por fim, analisar o conjunto e a relação entre as partes.Como escrever o relatório
  29. 29. Conclusão (último capítulo)A Conclusão deve dar resposta as seguintes questões:• Em que medida os objectivos foram alcançados?• Quais foram as lições aprendidas?• Quais são as ideias para trabalhos futuros?• Quais são as vantagens e desvantagens da solução apresentada, facea outras já existentes?Como escrever o relatório
  30. 30. ReferênciasEsta secção lista as referências bibliográficas citadas no texto.Deverá haver citação de uma referência sempre que se utilizem ideias,conhecimentos ou métodos que não são da nossa autoria.As referências não devem incluir documentos que não foram citados notexto. Caso existam, devem ser descritos na secção Bibliografia.Os itens da lista de referências são normalmente ordenados segundo oseu aparecimento no texto e a ordem é identificada por um número entreparênteses.Como escrever o relatório
  31. 31. Referências (norma portuguesa)A norma portuguesa para referências bibliográficas está harmonizadacom a norma ISO 690 e define estilos para diferentes tipos dedocumentos:NP 405-1 – Documentos impressosNP 405-2 – Material não livroNP 405-3 e NP 405-4 – Documentos não publicados e documentoselectrónicos.A norma NP 405 define 3 formas alternativas de citação: autor-data,citação-nota e citação numérica.www.ipq.ptComo escrever o relatório
  32. 32. Referências (norma portuguesa)SILVA, Maria Cardeira da – Um Islão prático: o quotidiano feminino em meio popularmuçulmano. Oeiras : Celta, 1999. ISBN 972-774-027-8.Como escrever o relatórioKANO, 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.REEVES, Emer P., [et al.] – Killing of neutrophilis is mediated trough activation ofproteases by K+ flux. Nature. London : Macmillan. ISBN 0028-0836. 416:6878 (2002)291-297.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.LivroCapítuloArtigoDocumento electrónico
  33. 33. Referências (norma portuguesa)(1) SILVA, Maria Cardeira da – Um Islão prático: o quotidiano feminino em meiopopular muçulmano. 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 ofproteases 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 relatórioCitações numéricas
  34. 34. Referências (norma portuguesa)Como escrever o relatórioÉ sabido que “1013cálculos por segundo produzem o efeito de cerca de 1011neurónios” (Moravec, 1992, p.243), o que atribui a cada neurónio 100 cálculos por segundo.Segundo Hans Moravec, um neurónio executa 100 cálculos por segundo, tendo em conta que “1013cálculos porsegundo produzem o efeito de cerca de 1011neurónios” (1992, p. 243).É sabido que “1013cálculos por segundo produzem o efeito de cerca de 1011neurónios” 1, o que atribui a cadaneurónio 100 cálculos por segundo.. . .______________________1MORAVEC, Hans – Homens e Robots, p. 243.Hans Moravec refere que “1013 cálculos por segundo produzem o efeito de cerca de 1011 neurónios” (8), o queatribui a cada neurónio 100 cálculos por segundo.Citação autor-dataCitação autor-data com o nome do autor no textoCitação-notaCitação numérica
  35. 35. Referências (norma APA)A American Psychological Association (APA) definiu um estilo de escritapara textos científicos e uma norma para referências bibliográficas quesão conhecidos e usados em todo o mundo por serem simples.www.apastyle.comComo escrever o relatório
  36. 36. Referências (norma APA)Bastos, S. P. (1997). O Estado Novo e os seus vadios: contribuição para o estudo dasidentidades marginais e da sua repressão. Portugal de Perto. Lisboa: D. Quixote.Como escrever o relatórioSilva, M. C. (1996) O suq das vaidades: Escolhas e performances corporais femininas emMarrocos. In M. V. de Almeida (Org.), Corpo presente: Treze reflexões antropológicassobre o corpo (pp. 54-71). Oeiras: Celta.Page, E. et al. (1968). The use of the computer in analyzing student essays. InternationalReview of Education, 14, 253-263.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.LivroCapítuloArtigoDocumento electrónico
  37. 37. Referências (norma APA)Como escrever o relatório“1013cálculos por segundo produzem o efeito de cerca de 1011neurónios” (Moravec, 1992).Segundo Moravec, um neurónio executa 100 cálculos por segundo, tendo em conta que “1013cálculos por segundoproduzem o efeito de cerca de 1011neurónios” (1992).“A migração tende a reduzir a diferenciação genética entre grupos que trocam indivíduos e genes” (Melnick &Pearl, 1987, p. 133).Citação de autor únicoCitação de autor único com o nome do autor no textoCitação com dois autores
  38. 38. AnexosSão documentos, produzidos ou não pelo autor, que surgem após o textopara introduzirem informação complementar ou afim ao assuntoabordado no relatório.Cada anexo deve ser identificado pela palavra “Anexo”, seguida de umaletra maiúscula a começar em “A”.A paginação dos anexos deve ser consecutiva e continuar a paginaçãodo texto principal.Como escrever o relatório
  39. 39. Estilo da redacção• A escrita deve ser impessoal.• Não devem ser utilizadas formas enfáticas, como ponto de exclamação ou reticências.• Não devem ser usadas frases muito longas.• O texto deve ter um encadeamento lógico e ser coeso. A utilização de referências aoutras partes do relatório reforça a coesão do mesmo.• Um termo deve ser sempre definido quando é utilizado pela primeira vez.• As citações e referências bibliográficas devem ser feitas de acordo com normas próprias.• As citações devem ser fieis. Se se eliminar alguma porção do texto, isso deve serindicado com reticências (…).• Todas as figuras, tabelas e fórmulas devem ser referenciadas no texto. A primeirareferência deve aparecer o mais perto possível do correspondente elemento.• Os títulos de capítulos devem aparecer no início de uma nova página.• Os títulos das secções não devem estar muito perto do fim da página ou ter poucaslinhas entre o início da página e eles próprios.Como escrever o relatório
  40. 40. Estilo gráfico (formato geral)Como escrever o relatórioMargem superior de 2,5 cmFormato A4Papel branco 80g/m2Numeração árabeNo rodapé e alinhada à direitaFonte Times New RomanTamanho 12Espaçamento entre linhasde 1,5 linhasMargem direita de 2 cmMargem esquerda de 3 cmMargem inferior de 2,5 cmEspaçamento de 6pt antese 12pt depois
  41. 41. Estilo gráfico (títulos)Como escrever o relatórioTimes New Roman 24 + BoldEspaçamento:18 Antes, 12 DepoisTimes New Roman 16 + BoldEspaçamento:18 Antes, 12 DepoisTimes New Roman 13 + BoldEspaçamento:18 Antes, 12 Depois
  42. 42. Estilo gráfico (figuras)Como escrever o relatórioCentrada e a cores senecessárioEspaçamentoconstanteReferenciada no textoIdentificação do capítuloPosicionada a seguir, concisa,com ref. bibliográfica senecessário
  43. 43. Estilo gráfico (tabelas)Como escrever o relatórioCentrada e a cores senecessárioEspaçamentoconstanteReferenciada no textoPosicionada antes, comidentificação do capítulo
  44. 44. Estilo gráfico (fórmulas)Como escrever o relatórioNumeradas de formasimples, ou comidentificação do capítulo aque pertencemEspaçamentoconstanteReferenciadas no texto,Descrição dasvariáveis sempreque necessário
  45. 45. Processador de textoAlgumas funcionalidades muito úteis:• Construção automática do índice• Numeração automática de tabelas, figuras, equações, etc.• Referências cruzadas• Notas de rodapé• Cabeçalhos e rodapés diferenciados• Numeração de páginas• Organização das referências bibliográficas• Construção do índice remissivoComo escrever o relatório
  46. 46. Sugestão para quem não gosta de escrever relatóriosContar a história apenas comfiguras e tabelas, depoisacrescentar texto para descreveresses elementos e por fimacrescentar texto para ligar asvárias partes.Como escrever o relatório
  47. 47. Recursosteses.mediateca.infow3.ualg.pt/~lnunes/Textosdeapoio/normas.PDFComo escrever o relatório
  48. 48. Recomendações finais• Não deixar o relatório para o fim!• Não deixar o relatório para o fim!!!• Não deixar o relatório para o fim!!!!!!!!!!!!!!!!!!• Elaborar o relatório ao longo do projecto em colaboração com oprofessor orientador.• Organizar as referências bibliográficas à medida que vão aparecendo.• Não menosprezar nenhuma das partes do relatório, sobretudo as quedescrevem o trabalho desenvolvido!• Contar a história com figuras e tabelas educativas.• Usar as potencialidades dos modernos processadores de texto.• Ler relatórios de referência de anos anteriores.• Anexar uma cópia em suporte digital do “protótipo” desenvolvido.• Escolher uma encadernação profissional.• Não deixar o relatório para o fim!!!!!!!!!!!!!!!!!!Como escrever o relatório

×