SlideShare ist ein Scribd-Unternehmen logo
1 von 6
Downloaden Sie, um offline zu lesen
Contributos para a Escrita de um Relatório
Prof. Luís Correia,
DEEC, IST
• Relatório
• Um Relatório é um documento técnico, descrevendo um problema e o trabalho realizado
para o resolver.
• Um Relatório deve formular o problema estudado, enquadrar o trabalho realizado
comparativamente a outros disponíveis na literatura, descrever os métodos utilizados na
resolução do problema, caracterizar o desempenho dos métodos usados 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).
• 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; a separação entre linhas
deve ser de At least 12 pt (equivalente a Single line) para Trabalhos Finais de Curso, e At
least 18 pt (equivalente a 1.5 lines) para outro tipo de relatórios, incluindo Teses de
Mestrado e de Doutoramento. 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 árabe, Arab numbering (1, 2, 3, ...), deve começar apenas na primeira
página de Introdução. Antes disso, deve usar-se small Roman numbering (i, ii, iii, ...).
• A numeração deve começar na folha a seguir à capa.
• Estrutura
• A estrutura do relatório deve ser a seguinte (começando em páginas separadas, e ímpares,
excepto Resumo/Abstract e as Listas, que não devem ter páginas em branco a separá-las):
• Página de capa, contendo instituição, título do trabalho, autores, local e data, de acordo
com o formato indicado
• Agradecimentos
• Resumo e Palavras Chave (uma só página para tudo, e as últimas no fim da página)
• Abstract e Keywords (traduzir para inglês o conteúdo da página anterior)
• Índice
• Lista de Figuras
• Lista de Tabelas
• Lista de Siglas
• Lista de Símbolos
• Lista de Programas
• 1. Introdução
• 2. Capítulo...
• 3. Capítulo...
• ...
• ?. Conclusões
• A. Anexo...
• B. Anexo...
• ...
• Referências
• Conteúdo e estrutura dos capítulos
• O Resumo deve enunciar o problema estudado, os métodos empregues e as principais
conclusões do trabalho. Não deve conter frases generalistas ou de introdução ao problema,
mas antes frases curtas e sucintas. Deve fornecer-se também, quando é o caso, os principais
resultados numéricos.
• As Palavras Chave devem ser em número de 5 ou 6, representado as grandes áreas do
trabalho, e sendo listadas por ordem decrescente de generalidade.
• O Índice deve conter toda a estrutura do relatório, isto é, quer as partes numeradas a i quer
as outras numeradas a 1.
• As Listas de figuras e tabelas devem conter todas as existentes no trabalho, incluindo
portanto as dos anexos. As Listas de símbolos, figuras, tabelas, e outras, devem ser
ordenadas. As Listas de Figuras e Tabelas devem conter as páginas onde estas estão
localizadas. No caso da Lista de Símbolos, estes devem ser agrupados em três classes (letras
gregas, letras romanas, e outros símbolos) antes de serem ordenados.
• 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. Deve descrever, de forma sucinta, o problema em
estudo, e enunciar os principais métodos que são utilizados no relatório.
Deve ainda fazer o “estado da arte”, com referências a trabalhos anteriores, referindo outras
alternativas para a resolução do problema (caso se deseje, pode-se fazer aqui um estado da
arte superficial, incluindo-se o estado da arte aprofundado no 2º Capítulo). Depois disso,
deve descrever-se o conteúdo e estrutura do relatório. Deve ser finalizada com a
identificação clara dos aspectos inovadores do trabalho.
• 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. A primeira
secção deve começar no princípio do capítulo. Não incluir secções ou subsecções com
menos de uma página. Não criar apenas uma secção (subsecção) dentro de um capítulo
(secção). Evitar criar subsecções com demasiados níveis, devendo-se usar apenas até ao 3º
nível, e.g., 1.1.1.
• Quando se realizam medidas ou simulações, e se descrevem os seus resultados, deve ter-
se o cuidado de descrever também de modo claro as condições e os pressupostos em que
aquelas foram realizadas.
• Quando se aborda um modelo, deve ter-se o cuidado de incluir os seus pressupostos, as
condições de aplicação, os parâmetros de entrada, a descrição do modelo, os parâmetros de
saída, e os erros associados à sua aplicação.
• As Conclusões devem conter os principais resultados do trabalho, apresentando-se
números e ordens de grandeza, indicando-se quais os melhores modelos ou técnicas, para
além de uma análise crítica das limitações. Deve começar por formular o problema
abordado no trabalho, após o que deve apresentar as conclusões dos vários capítulos,
finalizando com possíveis sugestõ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 (como por exemplo gráficos
com resultados de simulações para situações que foram abordadas mas não foram
mostradas no texto principal).
• 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.
• Abreviaturas comuns:
• e.g. (exempli gratia) – por exemplo
• et al. (et aliae) – e outros (para pessoas)
• etc. (et cetera) – e outros (para coisas)
• i.e. (id est) – isto é
• 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.
Por exemplo não usar fading, array, pattern, mas usar handover, hardware, software.
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 incluir referências no título de capítulos, secções ou subsecções.
• Não deixar o título de secções ou subsecções isolados no fim de uma página.
• Não começar uma secção referindo-se ao seu título, isto é, não se deve fazer
2.2.2. Modelo de Erlang
Este modelo é aplicável a....
• Equações e matemática
• As equações devem ser alinhadas à esquerda, e numeradas à direita, sequencialmente, por
capítulo. Por exemplo:
c = f λ (3.4)
• Os símbolos matemáticos devem ser escritos em fonte itálica, com excepção do alfabeto
grego. Todos devem ser escritos com um tamanho equivalente ao do texto restante, excepto
no que diz respeito a índices, que deverão ser mais pequenos. As unidades não devem ser
escritas em fonte itálica.
• Definir sempre os símbolos depois das equações, na primeira vez que são utilizados.
• Indicar as unidades das grandezas nas equações (em índice), sempre que aquelas não
venham nas suas unidades fundamentais. Por exemplo:
EIRP[dBm] = Pe [dBm] + Ge [dBi] (2.1)
• Não usar o mesmo símbolo para grandezas diferentes.
• Deve ter-se o cuidado de escrever o mesmo símbolo sempre da mesma forma, isto é, com
o mesmo tamanho de fonte (como por exemplo para os índices), com o mesmo significado,
etc.
• Os vectores e matrizes devem ser representados por letras a grosso (bold) e não por setas.
• 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 em vez de 12345.
• Quando se tem números inferiores à unidade, deve usar-se sempre o zero à esquerda, isto
é, deve usar-se 0,25 em vez de ,25.
• Referir as equações apenas pelo seu número (excepto no início de uma frase). Por
exemplo:
Deduz-se de (2.30) que não existe variação com a frequência. A equação (3.34) mostra a
dependência com a distância.
• Não indicar o número das equações quando estas surgem sequencialmente no texto.
Por exemplo:
EIRP é dada por
EIRP[dBm] = Pe [dBm] + Ge [dBi] (5.12)
• Figuras e Tabelas
• Há apenas Figuras e Tabelas, e nada mais (como por exemplo, Gráficos, Quadros,
Fotografias,...).
• 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.
• Em geral, os números devem possuir a mesma precisão numa mesma Tabela.
• Os números em Tabelas não devem vir centrados, mas sim alinhados por ordem de
grandeza, para se poder perceber melhor a sua diferença.
• As legendas devem ser sempre incluídas e centradas no texto. Por exemplo:
Figura 2.1 - Unidade móvel.
Tabela 3.5 - Lista de parâmetros.
• A legenda das Figuras deve vir depois destas, e a das Tabelas antes destas.
• No caso das Figuras incluírem múltiplos gráficos (do tipo (a), (b), (c)), a legenda
particular deve vir junto ao gráfico e não englobado na legenda geral. Por exemplo,
(a) Urbano (b) Suburbano
Figura 3.1 – Comparação do bloqueio para os ambientes urbano e suburbano.
• Espaço adicional (equivalente a uma linha) deve ser deixado antes e depois das Figuras e
Tabelas.
• Deve colocar-se as Figuras e as Tabelas no texto só depois de nele virem referenciadas, o
que deve acontecer sempre. Referenciar as figuras explicitamente, em vez de o fazer em
termos de posição. Por exemplo, fazer
A Fig. 3.1 mostra o comportamento da potência do sinal em função da dispersão do atraso.
Em vez de
A figura abaixo mostra o comportamento da potência do sinal em função da dispersão do atraso.
• Quando as Figuras ou Tabelas não cabem no fim de uma página, não se deve deixar o
espaço em branco correspondente a colocá-las no princípio da página seguinte; deve antes
continuar-se o texto, preenchendo o espaço até ao fim da página. Não é portanto obrigatório
que as Figuras ou Tabelas sejam colocadas no texto imediatamente a serem referidas neste.
• As Figuras contendo gráficos devem possuir legendas nos dois eixos, com a entidade
representada e respectivas unidades. Por exemplo:
EIRP [dBm]
• As escalas das Figuras, nomeadamente a vertical, devem ser escolhidas de modo a
expandir o mais possível a variação da função representada, em vez de esta ser comprimida
pela utilização de uma escala muito grande. A excepção ocorre quando se pretende
comparar curvas, em gráficos numa mesma página.
• As legendas e escalas das Figuras, bem como os conteúdos das Tabelas, devem ser
escritos com uma fonte de tamanho equivalente ao do texto restante.
• Não repetir o título de um gráfico por cima deste, quando a informação consta da legenda
da Figura.
• Quando uma tabela não cabe numa só página, as páginas de continuação devem conter
novamente a legenda, com indicação de continuação, como por exemplo,
Tabela 4.5 (cont.) – Parâmetros do modelo.
• Quando se refere 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.
• Quando se copia Figuras de outros autores, esse facto deve ser incluído na legenda.
Por exemplo:
Figura 4.5 - Cenário de propagação (extraído de [6]).
• Referências
• Deve usar-se referências no texto sempre que se cita ou se usa resultados de outros
autores. Referir a referência apenas pela sua indicação, sem explicitar a palavra referência,
excepto no início de uma frase. Por exemplo:
Os produtos resultantes de Peixe e Carne [2] têm sido usados desde o aparecimento da
humanidade. A referência [3] no entanto foi a primeira a propor que se seja vegetariano.
• As referências devem ser numeradas pela ordem que aparecem no texto.
• Não incluir referências que não foram citadas no texto.
• Caso se deseje, pode incluir-se Bibliografia, contendo textos que não foram citados ao
longo do trabalho, mas que são importantes para uma compreensão ou enquadramento do
trabalho em determinados aspectos.
• No texto (mas nunca nas referências, onde a informação deve estar completa), quando se
pretende referir os nomes dos autores, e estes são mais de 2, pode usar-se apenas o nome do
primeiro seguido de “et al.”. Por exemplo:
Okumura et al. [2] efectuaram medidas numa banda larga de frequências.
• A informação das referências deve estar completa, de acordo com os formatos que se
indicam abaixo.
• O formato deve ser
• para um livro
[1] Parsons,J.D., The Mobile Radio Propagation Channel, Pentech Press, London, UK,
1992.
i.e., nome(s) do(s) autor(es), título do livro, nome da editora, local da edição, país
da edição, ano da edição.
• para um artigo em revista
[2] Fernandes,L., "Developing a System Concept and Technologies for Mobile Broadband
Communications", IEEE Personal Communications Magazine, Vol. 2, No. 1, Feb.
1995, pp. 54-59.
i.e., nome(s) do(s) autor(es), título do artigo, nome da revista, volume da edição, número da
edição, mês da edição (abreviado com 3 letras, excepção aos meses com 4 letras), ano da
edição, páginas.
• para uma comunicação em conferência
[3] Correia,L.M. and Francês,P.O., "A Propagation Model for the Average Received
Power in an Outdoor Environment in the Millimetre Waveband", in Proc. of VTC’94 -
44 th IEEE Vehicular Technology Conference, Stockholm, Sweden, June 1994.
i.e., nome(s) do(s) autor(es), título da comunicação, nome da conferência, local da
conferência, país da conferência, mês da conferência (abreviado com 3 letras, excepção aos
meses com 4 letras), ano da conferência.
• para uma tese
[4] Mockford,S., Narrowband Characterization of UHF Mobile Radio Channels in Rural Areas, Ph.
D. Thesis, University of Liverpool, Liverpool, UK, 1989.
i.e., nome do autor, título da tese, tipo de tese, universidade da tese, local da universidade,
país da universidade, ano da tese.
• para um relatório interno
[5] Correia,L.M. (ed.), Brázio,L.M., Mohamed,S., Francês,P.O., Velez,F. and Gilliland,J., Report on
Design Rules for Cell Layout, RACE-MBS Project, Deliverable R2076/IST/2.2.3/DS/P/044.b1,
European Commission - DG XIII/B, Brussels, Belgium, Nov. 1994.
i.e., nome(s) do(s) autor(es), título do relatório, origem do relatório, referência do relatório,
instituição de acesso ao relatório, local da instituição, país da instituição, mês do relatório
(abreviado com 3 letras, excepção aos meses com 4 letras), ano do relatório.
• para um documento extraído da Internet
[6] Mockford, S., Narrowband Characterization of UHF Mobile Radio Channels in Rural Areas,
Internal Report, University of Liverpool, Liverpool, UK, 1989
(http://uliverpool.ac.uk/~radiolab/thesis/doc12.pdf).
i.e., adicionar o endereço entre parênteses.
• para um portal da Internet
[7] http://www.lx.it.pt/grow
i.e., o endereço.
• Caso se deseje, pode-se fazer as referências usando 4 letras e 2 dígitos, em vez de as
numerar pela ordem em que aparecem no texto: as letras dizem respeito ao nome dos
autores e os dígitos ao ano da publicação. No caso de publicações pelos mesmos autores no
mesmo ano, adiciona-se uma letra a seguir ao dígitos (a, b, c, d, ...). O formato
correspondente aos exemplos acima referidos é o seguinte: [1] - [Pars92], [2] - [Fern95], [3]
- [CoFr94], [4] - [Mock89a], [5] - [CBMF94], [6] - [Mock89b].
• A lista de referências no fim do trabalho deve vir ordenada, por ordem numérica ou
alfabética, consoante o método usado.
• Alguns processadores de texto possuem formas automáticas para gestão de referências,
pelo que se deve tirar partido disso, quando possível.
• 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.
1999-02-02
Luis M. Correia
(com sugestões de colegas)
Revisto em 2003-10-31

Weitere ähnliche Inhalte

Was ist angesagt?

Modelo formatação artigo científico
Modelo formatação artigo científicoModelo formatação artigo científico
Modelo formatação artigo científicoMarcos Azevedo
 
Modelo para formatacao de trabalhos academicos da utfpr vs8.1
Modelo para formatacao de trabalhos academicos da utfpr vs8.1Modelo para formatacao de trabalhos academicos da utfpr vs8.1
Modelo para formatacao de trabalhos academicos da utfpr vs8.1Elson Ribeiro
 
A estrutura do artigo científico da fanap e
A estrutura do artigo científico da fanap eA estrutura do artigo científico da fanap e
A estrutura do artigo científico da fanap enillima
 
Normas de apresentação gráfica do artigo
Normas de apresentação gráfica do artigoNormas de apresentação gráfica do artigo
Normas de apresentação gráfica do artigojo ramos
 
Manual normas uf_pel_trabalhos_acadêmicos
Manual normas uf_pel_trabalhos_acadêmicosManual normas uf_pel_trabalhos_acadêmicos
Manual normas uf_pel_trabalhos_acadêmicosDianaMarcelaHernande21
 
Modelo de artigo científico básico - com normas ABNT
Modelo de artigo científico básico - com normas ABNTModelo de artigo científico básico - com normas ABNT
Modelo de artigo científico básico - com normas ABNTRosineia Oliveira dos Santos
 
Tcc regras para artigo científico 2014 como fazer um artigo científico de q...
Tcc   regras para artigo científico 2014 como fazer um artigo científico de q...Tcc   regras para artigo científico 2014 como fazer um artigo científico de q...
Tcc regras para artigo científico 2014 como fazer um artigo científico de q...Daniel Souza
 
Resumo expandido conpesca ro
Resumo expandido conpesca roResumo expandido conpesca ro
Resumo expandido conpesca roFernanda
 
2406400 modelo-de-trabalhos-academicos
2406400 modelo-de-trabalhos-academicos2406400 modelo-de-trabalhos-academicos
2406400 modelo-de-trabalhos-academicosjanegustavo
 

Was ist angesagt? (18)

Modelo tcc 1_2 (5)
Modelo tcc 1_2 (5)Modelo tcc 1_2 (5)
Modelo tcc 1_2 (5)
 
Modelo formatação artigo científico
Modelo formatação artigo científicoModelo formatação artigo científico
Modelo formatação artigo científico
 
Modelo para formatacao de trabalhos academicos da utfpr vs8.1
Modelo para formatacao de trabalhos academicos da utfpr vs8.1Modelo para formatacao de trabalhos academicos da utfpr vs8.1
Modelo para formatacao de trabalhos academicos da utfpr vs8.1
 
Artigo modelo congresso
Artigo modelo congresso Artigo modelo congresso
Artigo modelo congresso
 
Modelo artigo biblio
Modelo artigo biblioModelo artigo biblio
Modelo artigo biblio
 
A estrutura do artigo científico da fanap e
A estrutura do artigo científico da fanap eA estrutura do artigo científico da fanap e
A estrutura do artigo científico da fanap e
 
Normas de apresentação gráfica do artigo
Normas de apresentação gráfica do artigoNormas de apresentação gráfica do artigo
Normas de apresentação gráfica do artigo
 
Manual normas uf_pel_trabalhos_acadêmicos
Manual normas uf_pel_trabalhos_acadêmicosManual normas uf_pel_trabalhos_acadêmicos
Manual normas uf_pel_trabalhos_acadêmicos
 
Modelos para publicar artigo - área do Direito
Modelos para publicar artigo - área do DireitoModelos para publicar artigo - área do Direito
Modelos para publicar artigo - área do Direito
 
Modelo de artigo científico básico - com normas ABNT
Modelo de artigo científico básico - com normas ABNTModelo de artigo científico básico - com normas ABNT
Modelo de artigo científico básico - com normas ABNT
 
Modelo de artigo cientifico
Modelo de artigo cientificoModelo de artigo cientifico
Modelo de artigo cientifico
 
Tcc regras para artigo científico 2014 como fazer um artigo científico de q...
Tcc   regras para artigo científico 2014 como fazer um artigo científico de q...Tcc   regras para artigo científico 2014 como fazer um artigo científico de q...
Tcc regras para artigo científico 2014 como fazer um artigo científico de q...
 
Artigo cientifico
Artigo cientificoArtigo cientifico
Artigo cientifico
 
Artigos cientificos
Artigos cientificosArtigos cientificos
Artigos cientificos
 
Normas Para O Resumo Simples
Normas Para O Resumo SimplesNormas Para O Resumo Simples
Normas Para O Resumo Simples
 
Resumo expandido conpesca ro
Resumo expandido conpesca roResumo expandido conpesca ro
Resumo expandido conpesca ro
 
Artigo cientifico
Artigo cientificoArtigo cientifico
Artigo cientifico
 
2406400 modelo-de-trabalhos-academicos
2406400 modelo-de-trabalhos-academicos2406400 modelo-de-trabalhos-academicos
2406400 modelo-de-trabalhos-academicos
 

Andere mochten auch

MSc Dissertation UB_15014022 Noriyuki
MSc Dissertation UB_15014022 NoriyukiMSc Dissertation UB_15014022 Noriyuki
MSc Dissertation UB_15014022 NoriyukiNoriyuki Dochi
 
CDM Solid Modeling Cert
CDM Solid Modeling CertCDM Solid Modeling Cert
CDM Solid Modeling CertJerry Horton
 
Informe de RSC de Abengoa Solar
Informe de RSC de Abengoa SolarInforme de RSC de Abengoa Solar
Informe de RSC de Abengoa SolarAbengoa
 
One sheet - Gabriela Martina
One sheet - Gabriela MartinaOne sheet - Gabriela Martina
One sheet - Gabriela MartinaGabriela Heer
 
Personal Branding Masterclass for Coaches, Consultants, Solopreneurs & Small ...
Personal Branding Masterclass for Coaches, Consultants, Solopreneurs & Small ...Personal Branding Masterclass for Coaches, Consultants, Solopreneurs & Small ...
Personal Branding Masterclass for Coaches, Consultants, Solopreneurs & Small ...horling wong
 
Anvesh Updated resume-2016
Anvesh Updated resume-2016Anvesh Updated resume-2016
Anvesh Updated resume-2016Anvesh Kumar
 
営業現場におけるタブレットの活用例
営業現場におけるタブレットの活用例営業現場におけるタブレットの活用例
営業現場におけるタブレットの活用例sunao Inoue
 
Intrapreneurship & colaboração !
Intrapreneurship & colaboração !Intrapreneurship & colaboração !
Intrapreneurship & colaboração !EDGE GROUP
 
Guia de qualidade_para_sistemas[1]
Guia de qualidade_para_sistemas[1]Guia de qualidade_para_sistemas[1]
Guia de qualidade_para_sistemas[1]cvsantos
 
002.10 ir alma_extracto
002.10 ir alma_extracto002.10 ir alma_extracto
002.10 ir alma_extractoDulce Abalada
 
Articulação entre a BE e os departamentos - agrupamento morgado de mateus
Articulação entre a BE e os departamentos - agrupamento morgado de mateusArticulação entre a BE e os departamentos - agrupamento morgado de mateus
Articulação entre a BE e os departamentos - agrupamento morgado de mateusAna Quelhas
 

Andere mochten auch (18)

MSc Dissertation UB_15014022 Noriyuki
MSc Dissertation UB_15014022 NoriyukiMSc Dissertation UB_15014022 Noriyuki
MSc Dissertation UB_15014022 Noriyuki
 
CDM Solid Modeling Cert
CDM Solid Modeling CertCDM Solid Modeling Cert
CDM Solid Modeling Cert
 
Informe de RSC de Abengoa Solar
Informe de RSC de Abengoa SolarInforme de RSC de Abengoa Solar
Informe de RSC de Abengoa Solar
 
Calendario judaico
Calendario judaicoCalendario judaico
Calendario judaico
 
One sheet - Gabriela Martina
One sheet - Gabriela MartinaOne sheet - Gabriela Martina
One sheet - Gabriela Martina
 
Personal Branding Masterclass for Coaches, Consultants, Solopreneurs & Small ...
Personal Branding Masterclass for Coaches, Consultants, Solopreneurs & Small ...Personal Branding Masterclass for Coaches, Consultants, Solopreneurs & Small ...
Personal Branding Masterclass for Coaches, Consultants, Solopreneurs & Small ...
 
Mi 11 ideal
Mi 11 idealMi 11 ideal
Mi 11 ideal
 
Anvesh Updated resume-2016
Anvesh Updated resume-2016Anvesh Updated resume-2016
Anvesh Updated resume-2016
 
La autoestima
La autoestimaLa autoestima
La autoestima
 
営業現場におけるタブレットの活用例
営業現場におけるタブレットの活用例営業現場におけるタブレットの活用例
営業現場におけるタブレットの活用例
 
Amissaodossignos1
Amissaodossignos1Amissaodossignos1
Amissaodossignos1
 
Intrapreneurship & colaboração !
Intrapreneurship & colaboração !Intrapreneurship & colaboração !
Intrapreneurship & colaboração !
 
skydrive_word_doc
skydrive_word_docskydrive_word_doc
skydrive_word_doc
 
UC-XC4IN5YK
UC-XC4IN5YKUC-XC4IN5YK
UC-XC4IN5YK
 
Guia de qualidade_para_sistemas[1]
Guia de qualidade_para_sistemas[1]Guia de qualidade_para_sistemas[1]
Guia de qualidade_para_sistemas[1]
 
O cortiço 2
O cortiço 2O cortiço 2
O cortiço 2
 
002.10 ir alma_extracto
002.10 ir alma_extracto002.10 ir alma_extracto
002.10 ir alma_extracto
 
Articulação entre a BE e os departamentos - agrupamento morgado de mateus
Articulação entre a BE e os departamentos - agrupamento morgado de mateusArticulação entre a BE e os departamentos - agrupamento morgado de mateus
Articulação entre a BE e os departamentos - agrupamento morgado de mateus
 

Ähnlich wie Como escrever um relatório técnico

Orientações relatório administração, meio ambiente e química da Escola Técnic...
Orientações relatório administração, meio ambiente e química da Escola Técnic...Orientações relatório administração, meio ambiente e química da Escola Técnic...
Orientações relatório administração, meio ambiente e química da Escola Técnic...Luiz Avelar
 
Revista de engenharia agrícola normas para enviar artigo
Revista de engenharia agrícola   normas para enviar artigoRevista de engenharia agrícola   normas para enviar artigo
Revista de engenharia agrícola normas para enviar artigoEmlur
 
Como Apresentar Um Trabalho 2
Como Apresentar Um Trabalho  2Como Apresentar Um Trabalho  2
Como Apresentar Um Trabalho 2BE/CRE
 
Modelo artigo técnico publicação
Modelo artigo técnico publicaçãoModelo artigo técnico publicação
Modelo artigo técnico publicaçãoElmo Dutra Filho
 
Orientacoes resumo expandido
Orientacoes resumo expandidoOrientacoes resumo expandido
Orientacoes resumo expandidokarlajanys
 
Orientacoes resumo expandido
Orientacoes resumo expandidoOrientacoes resumo expandido
Orientacoes resumo expandidokarlajanys
 
Modelo de relatório de aula prática
Modelo de relatório de aula práticaModelo de relatório de aula prática
Modelo de relatório de aula práticaTEYSON VASCONCELOS
 
4 estrutura do trabalho acadêmico tcc
4 estrutura do trabalho acadêmico   tcc4 estrutura do trabalho acadêmico   tcc
4 estrutura do trabalho acadêmico tccdiemili
 

Ähnlich wie Como escrever um relatório técnico (20)

Modelo relatorio tecnico
Modelo relatorio tecnicoModelo relatorio tecnico
Modelo relatorio tecnico
 
Orientações relatório administração, meio ambiente e química da Escola Técnic...
Orientações relatório administração, meio ambiente e química da Escola Técnic...Orientações relatório administração, meio ambiente e química da Escola Técnic...
Orientações relatório administração, meio ambiente e química da Escola Técnic...
 
Revista de engenharia agrícola normas para enviar artigo
Revista de engenharia agrícola   normas para enviar artigoRevista de engenharia agrícola   normas para enviar artigo
Revista de engenharia agrícola normas para enviar artigo
 
Normas4
Normas4Normas4
Normas4
 
TCC I CRIMINOLOGIA EDIT.pdf
TCC I CRIMINOLOGIA EDIT.pdfTCC I CRIMINOLOGIA EDIT.pdf
TCC I CRIMINOLOGIA EDIT.pdf
 
TCC BIOMEDICINA EDIT.docx.pdf
TCC BIOMEDICINA EDIT.docx.pdfTCC BIOMEDICINA EDIT.docx.pdf
TCC BIOMEDICINA EDIT.docx.pdf
 
Artigo
ArtigoArtigo
Artigo
 
Como Apresentar Um Trabalho 2
Como Apresentar Um Trabalho  2Como Apresentar Um Trabalho  2
Como Apresentar Um Trabalho 2
 
Modelo artigo técnico publicação
Modelo artigo técnico publicaçãoModelo artigo técnico publicação
Modelo artigo técnico publicação
 
Metodologia tgi 2009_michel
Metodologia tgi 2009_michelMetodologia tgi 2009_michel
Metodologia tgi 2009_michel
 
Modelo mod 3_4
Modelo mod 3_4Modelo mod 3_4
Modelo mod 3_4
 
Orientacoes monografia
Orientacoes monografiaOrientacoes monografia
Orientacoes monografia
 
Modelo de artigo de aula pratica, laboratorial ou de campo
Modelo de artigo de aula pratica, laboratorial ou de campoModelo de artigo de aula pratica, laboratorial ou de campo
Modelo de artigo de aula pratica, laboratorial ou de campo
 
Orientacoes resumo expandido
Orientacoes resumo expandidoOrientacoes resumo expandido
Orientacoes resumo expandido
 
Orientacoes resumo expandido
Orientacoes resumo expandidoOrientacoes resumo expandido
Orientacoes resumo expandido
 
Normas da abnt
Normas da abntNormas da abnt
Normas da abnt
 
Como.escrever.um.relatório
Como.escrever.um.relatórioComo.escrever.um.relatório
Como.escrever.um.relatório
 
Modelo de relatório de aula prática
Modelo de relatório de aula práticaModelo de relatório de aula prática
Modelo de relatório de aula prática
 
4 estrutura do trabalho acadêmico tcc
4 estrutura do trabalho acadêmico   tcc4 estrutura do trabalho acadêmico   tcc
4 estrutura do trabalho acadêmico tcc
 
Para escrever artigo ou tese
Para escrever artigo ou tesePara escrever artigo ou tese
Para escrever artigo ou tese
 

Como escrever um relatório técnico

  • 1. Contributos para a Escrita de um Relatório Prof. Luís Correia, DEEC, IST • Relatório • Um Relatório é um documento técnico, descrevendo um problema e o trabalho realizado para o resolver. • Um Relatório deve formular o problema estudado, enquadrar o trabalho realizado comparativamente a outros disponíveis na literatura, descrever os métodos utilizados na resolução do problema, caracterizar o desempenho dos métodos usados 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). • 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; a separação entre linhas deve ser de At least 12 pt (equivalente a Single line) para Trabalhos Finais de Curso, e At least 18 pt (equivalente a 1.5 lines) para outro tipo de relatórios, incluindo Teses de Mestrado e de Doutoramento. 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 árabe, Arab numbering (1, 2, 3, ...), deve começar apenas na primeira página de Introdução. Antes disso, deve usar-se small Roman numbering (i, ii, iii, ...). • A numeração deve começar na folha a seguir à capa. • Estrutura • A estrutura do relatório deve ser a seguinte (começando em páginas separadas, e ímpares, excepto Resumo/Abstract e as Listas, que não devem ter páginas em branco a separá-las): • Página de capa, contendo instituição, título do trabalho, autores, local e data, de acordo com o formato indicado • Agradecimentos • Resumo e Palavras Chave (uma só página para tudo, e as últimas no fim da página) • Abstract e Keywords (traduzir para inglês o conteúdo da página anterior) • Índice • Lista de Figuras • Lista de Tabelas • Lista de Siglas • Lista de Símbolos • Lista de Programas • 1. Introdução • 2. Capítulo...
  • 2. • 3. Capítulo... • ... • ?. Conclusões • A. Anexo... • B. Anexo... • ... • Referências • Conteúdo e estrutura dos capítulos • O Resumo deve enunciar o problema estudado, os métodos empregues e as principais conclusões do trabalho. Não deve conter frases generalistas ou de introdução ao problema, mas antes frases curtas e sucintas. Deve fornecer-se também, quando é o caso, os principais resultados numéricos. • As Palavras Chave devem ser em número de 5 ou 6, representado as grandes áreas do trabalho, e sendo listadas por ordem decrescente de generalidade. • O Índice deve conter toda a estrutura do relatório, isto é, quer as partes numeradas a i quer as outras numeradas a 1. • As Listas de figuras e tabelas devem conter todas as existentes no trabalho, incluindo portanto as dos anexos. As Listas de símbolos, figuras, tabelas, e outras, devem ser ordenadas. As Listas de Figuras e Tabelas devem conter as páginas onde estas estão localizadas. No caso da Lista de Símbolos, estes devem ser agrupados em três classes (letras gregas, letras romanas, e outros símbolos) antes de serem ordenados. • 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. Deve descrever, de forma sucinta, o problema em estudo, e enunciar os principais métodos que são utilizados no relatório. Deve ainda fazer o “estado da arte”, com referências a trabalhos anteriores, referindo outras alternativas para a resolução do problema (caso se deseje, pode-se fazer aqui um estado da arte superficial, incluindo-se o estado da arte aprofundado no 2º Capítulo). Depois disso, deve descrever-se o conteúdo e estrutura do relatório. Deve ser finalizada com a identificação clara dos aspectos inovadores do trabalho. • 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. A primeira secção deve começar no princípio do capítulo. Não incluir secções ou subsecções com menos de uma página. Não criar apenas uma secção (subsecção) dentro de um capítulo (secção). Evitar criar subsecções com demasiados níveis, devendo-se usar apenas até ao 3º nível, e.g., 1.1.1. • Quando se realizam medidas ou simulações, e se descrevem os seus resultados, deve ter- se o cuidado de descrever também de modo claro as condições e os pressupostos em que aquelas foram realizadas. • Quando se aborda um modelo, deve ter-se o cuidado de incluir os seus pressupostos, as condições de aplicação, os parâmetros de entrada, a descrição do modelo, os parâmetros de saída, e os erros associados à sua aplicação. • As Conclusões devem conter os principais resultados do trabalho, apresentando-se números e ordens de grandeza, indicando-se quais os melhores modelos ou técnicas, para além de uma análise crítica das limitações. Deve começar por formular o problema
  • 3. abordado no trabalho, após o que deve apresentar as conclusões dos vários capítulos, finalizando com possíveis sugestõ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 (como por exemplo gráficos com resultados de simulações para situações que foram abordadas mas não foram mostradas no texto principal). • 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. • Abreviaturas comuns: • e.g. (exempli gratia) – por exemplo • et al. (et aliae) – e outros (para pessoas) • etc. (et cetera) – e outros (para coisas) • i.e. (id est) – isto é • 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. Por exemplo não usar fading, array, pattern, mas usar handover, hardware, software. 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 incluir referências no título de capítulos, secções ou subsecções. • Não deixar o título de secções ou subsecções isolados no fim de uma página. • Não começar uma secção referindo-se ao seu título, isto é, não se deve fazer 2.2.2. Modelo de Erlang Este modelo é aplicável a.... • Equações e matemática • As equações devem ser alinhadas à esquerda, e numeradas à direita, sequencialmente, por capítulo. Por exemplo: c = f λ (3.4) • Os símbolos matemáticos devem ser escritos em fonte itálica, com excepção do alfabeto grego. Todos devem ser escritos com um tamanho equivalente ao do texto restante, excepto no que diz respeito a índices, que deverão ser mais pequenos. As unidades não devem ser escritas em fonte itálica. • Definir sempre os símbolos depois das equações, na primeira vez que são utilizados. • Indicar as unidades das grandezas nas equações (em índice), sempre que aquelas não venham nas suas unidades fundamentais. Por exemplo: EIRP[dBm] = Pe [dBm] + Ge [dBi] (2.1)
  • 4. • Não usar o mesmo símbolo para grandezas diferentes. • Deve ter-se o cuidado de escrever o mesmo símbolo sempre da mesma forma, isto é, com o mesmo tamanho de fonte (como por exemplo para os índices), com o mesmo significado, etc. • Os vectores e matrizes devem ser representados por letras a grosso (bold) e não por setas. • 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 em vez de 12345. • Quando se tem números inferiores à unidade, deve usar-se sempre o zero à esquerda, isto é, deve usar-se 0,25 em vez de ,25. • Referir as equações apenas pelo seu número (excepto no início de uma frase). Por exemplo: Deduz-se de (2.30) que não existe variação com a frequência. A equação (3.34) mostra a dependência com a distância. • Não indicar o número das equações quando estas surgem sequencialmente no texto. Por exemplo: EIRP é dada por EIRP[dBm] = Pe [dBm] + Ge [dBi] (5.12) • Figuras e Tabelas • Há apenas Figuras e Tabelas, e nada mais (como por exemplo, Gráficos, Quadros, Fotografias,...). • 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. • Em geral, os números devem possuir a mesma precisão numa mesma Tabela. • Os números em Tabelas não devem vir centrados, mas sim alinhados por ordem de grandeza, para se poder perceber melhor a sua diferença. • As legendas devem ser sempre incluídas e centradas no texto. Por exemplo: Figura 2.1 - Unidade móvel. Tabela 3.5 - Lista de parâmetros. • A legenda das Figuras deve vir depois destas, e a das Tabelas antes destas. • No caso das Figuras incluírem múltiplos gráficos (do tipo (a), (b), (c)), a legenda particular deve vir junto ao gráfico e não englobado na legenda geral. Por exemplo, (a) Urbano (b) Suburbano Figura 3.1 – Comparação do bloqueio para os ambientes urbano e suburbano. • Espaço adicional (equivalente a uma linha) deve ser deixado antes e depois das Figuras e Tabelas. • Deve colocar-se as Figuras e as Tabelas no texto só depois de nele virem referenciadas, o que deve acontecer sempre. Referenciar as figuras explicitamente, em vez de o fazer em termos de posição. Por exemplo, fazer A Fig. 3.1 mostra o comportamento da potência do sinal em função da dispersão do atraso. Em vez de A figura abaixo mostra o comportamento da potência do sinal em função da dispersão do atraso. • Quando as Figuras ou Tabelas não cabem no fim de uma página, não se deve deixar o espaço em branco correspondente a colocá-las no princípio da página seguinte; deve antes continuar-se o texto, preenchendo o espaço até ao fim da página. Não é portanto obrigatório que as Figuras ou Tabelas sejam colocadas no texto imediatamente a serem referidas neste. • As Figuras contendo gráficos devem possuir legendas nos dois eixos, com a entidade representada e respectivas unidades. Por exemplo:
  • 5. EIRP [dBm] • As escalas das Figuras, nomeadamente a vertical, devem ser escolhidas de modo a expandir o mais possível a variação da função representada, em vez de esta ser comprimida pela utilização de uma escala muito grande. A excepção ocorre quando se pretende comparar curvas, em gráficos numa mesma página. • As legendas e escalas das Figuras, bem como os conteúdos das Tabelas, devem ser escritos com uma fonte de tamanho equivalente ao do texto restante. • Não repetir o título de um gráfico por cima deste, quando a informação consta da legenda da Figura. • Quando uma tabela não cabe numa só página, as páginas de continuação devem conter novamente a legenda, com indicação de continuação, como por exemplo, Tabela 4.5 (cont.) – Parâmetros do modelo. • Quando se refere 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. • Quando se copia Figuras de outros autores, esse facto deve ser incluído na legenda. Por exemplo: Figura 4.5 - Cenário de propagação (extraído de [6]). • Referências • Deve usar-se referências no texto sempre que se cita ou se usa resultados de outros autores. Referir a referência apenas pela sua indicação, sem explicitar a palavra referência, excepto no início de uma frase. Por exemplo: Os produtos resultantes de Peixe e Carne [2] têm sido usados desde o aparecimento da humanidade. A referência [3] no entanto foi a primeira a propor que se seja vegetariano. • As referências devem ser numeradas pela ordem que aparecem no texto. • Não incluir referências que não foram citadas no texto. • Caso se deseje, pode incluir-se Bibliografia, contendo textos que não foram citados ao longo do trabalho, mas que são importantes para uma compreensão ou enquadramento do trabalho em determinados aspectos. • No texto (mas nunca nas referências, onde a informação deve estar completa), quando se pretende referir os nomes dos autores, e estes são mais de 2, pode usar-se apenas o nome do primeiro seguido de “et al.”. Por exemplo: Okumura et al. [2] efectuaram medidas numa banda larga de frequências. • A informação das referências deve estar completa, de acordo com os formatos que se indicam abaixo. • O formato deve ser • para um livro [1] Parsons,J.D., The Mobile Radio Propagation Channel, Pentech Press, London, UK, 1992. i.e., nome(s) do(s) autor(es), título do livro, nome da editora, local da edição, país da edição, ano da edição. • para um artigo em revista [2] Fernandes,L., "Developing a System Concept and Technologies for Mobile Broadband Communications", IEEE Personal Communications Magazine, Vol. 2, No. 1, Feb. 1995, pp. 54-59. i.e., nome(s) do(s) autor(es), título do artigo, nome da revista, volume da edição, número da edição, mês da edição (abreviado com 3 letras, excepção aos meses com 4 letras), ano da edição, páginas. • para uma comunicação em conferência
  • 6. [3] Correia,L.M. and Francês,P.O., "A Propagation Model for the Average Received Power in an Outdoor Environment in the Millimetre Waveband", in Proc. of VTC’94 - 44 th IEEE Vehicular Technology Conference, Stockholm, Sweden, June 1994. i.e., nome(s) do(s) autor(es), título da comunicação, nome da conferência, local da conferência, país da conferência, mês da conferência (abreviado com 3 letras, excepção aos meses com 4 letras), ano da conferência. • para uma tese [4] Mockford,S., Narrowband Characterization of UHF Mobile Radio Channels in Rural Areas, Ph. D. Thesis, University of Liverpool, Liverpool, UK, 1989. i.e., nome do autor, título da tese, tipo de tese, universidade da tese, local da universidade, país da universidade, ano da tese. • para um relatório interno [5] Correia,L.M. (ed.), Brázio,L.M., Mohamed,S., Francês,P.O., Velez,F. and Gilliland,J., Report on Design Rules for Cell Layout, RACE-MBS Project, Deliverable R2076/IST/2.2.3/DS/P/044.b1, European Commission - DG XIII/B, Brussels, Belgium, Nov. 1994. i.e., nome(s) do(s) autor(es), título do relatório, origem do relatório, referência do relatório, instituição de acesso ao relatório, local da instituição, país da instituição, mês do relatório (abreviado com 3 letras, excepção aos meses com 4 letras), ano do relatório. • para um documento extraído da Internet [6] Mockford, S., Narrowband Characterization of UHF Mobile Radio Channels in Rural Areas, Internal Report, University of Liverpool, Liverpool, UK, 1989 (http://uliverpool.ac.uk/~radiolab/thesis/doc12.pdf). i.e., adicionar o endereço entre parênteses. • para um portal da Internet [7] http://www.lx.it.pt/grow i.e., o endereço. • Caso se deseje, pode-se fazer as referências usando 4 letras e 2 dígitos, em vez de as numerar pela ordem em que aparecem no texto: as letras dizem respeito ao nome dos autores e os dígitos ao ano da publicação. No caso de publicações pelos mesmos autores no mesmo ano, adiciona-se uma letra a seguir ao dígitos (a, b, c, d, ...). O formato correspondente aos exemplos acima referidos é o seguinte: [1] - [Pars92], [2] - [Fern95], [3] - [CoFr94], [4] - [Mock89a], [5] - [CBMF94], [6] - [Mock89b]. • A lista de referências no fim do trabalho deve vir ordenada, por ordem numérica ou alfabética, consoante o método usado. • Alguns processadores de texto possuem formas automáticas para gestão de referências, pelo que se deve tirar partido disso, quando possível. • 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. 1999-02-02 Luis M. Correia (com sugestões de colegas) Revisto em 2003-10-31