Instruções para a Escrita do Relatório Formal

Transcrição

1 UNIVERSIDADE TÉCNICA DE LISBOA INSTITUTO SUPERIOR TÉCNICO INSTRUMENTAÇÃO E MEDIDAS Instruções para a Escrita do Relatório Formal Nº aluno Nome do aluno Nº aluno Nome do aluno Nº aluno Nome do aluno Grupo Turno (hora, dia da semana) Docente 28 de Fevereiro de 2011

2 I. Introdução Um relatório é um documento técnico, que descreve um problema e o trabalho realizado para o resolver; deve ser completo, preciso e conciso: Completo: deve formular e enquadrar o problema estudado, e incluir toda a informação sobre os resultados obtidos, como foram obtidos (métodos, equipamentos e circunstâncias) e como se interpretam. Preciso: deve dar informações e fazer críticas qualificadas e objectivas. Conciso: deve dar exclusiva, directa e claramente informação sobre o assunto de que é objecto. II. Objectivo O objectivo principal deste documento é ajudar os alunos a cuidar na apresentação de um relatório. As recomendações formuladas foram estabelecidas para sistematizar e uniformizar a forma de apresentação dos trabalhos de laboratório na disciplina de Instrumentação e Medidas, nomeadamente o relatório formal. III. Estrutura do Relatório A estrutura do relatório deve ser a seguinte: 1) Página de capa, contendo instituição, título do trabalho, autores, local e data. 2) Introdução: deve descrever, de forma sucinta, os objectivos ou o problema em estudo, e enunciar os principais métodos que são utilizados no relatório. 3) Texto base: este pode estar dividido em secções e subsecções, de forma equilibrada, cada uma contendo partes relativamente separadas do trabalho, que incluam os aspectos teóricos envolvidos, os métodos, procedimentos e equipamentos utilizados, descritos de um modo que o leitor perceba o que foi feito e a forma como foi efectuado. 4) Conclusões: devem estar suportadas nos principais resultados do trabalho que são apresentados e não em outros, hipotéticos ou não apresentados; devem reflectir uma interpretação dos resultados, comparações com as previsões teóricas, e apresentar justificações adequadas para eventuais desvios encontrados. 5) Documentos auxiliares divididos em Apêndices. Os Apêndices contêm informação adicional, que não é fundamental para a compreensão do trabalho, ou que é suplementar ao corpo principal do relatório. 1

3 6) Referências ou Bibliografia. As Referências têm de ser todas referenciadas no texto e numeradas entre parênteses rectos e de acordo com a ordem com que são referidas no texto. Bibliografia é um conjunto de documentos consultados no âmbito do trabalho. Neste caos, os documentos não são referenciados no texto e não são numerados. Todo o conteúdo do relatório tem de ser original. IV. Formato geral do Relatório O formato do papel é A4, ao alto. As margens devem ser de 2,5 cm, quer na vertical quer na horizontal. A separação entre linhas deve ser 1½ espaços (equivalente a 1.5 lines ). A fonte Arial, negrito (bold) e com um tamanho de 14 pontos com espaçamento de 12 pt antes e 6 pt depois deve ser usada nos títulos de secções e subsecções. Todo o restante texto deve ser escrito a uma coluna, com a fonte Times New Roman, normal e um tamanho de 12 pontos, excepto nas legendas das figuras e tabelas, onde o tamanho deve ser de 10 pontos. Nunca utilizar sublinhado nem negrito. O relatório é apresentado em frente e verso (ou em formato electrónico PDF), e não pode exceder, no total, 15 páginas. A numeração das páginas, em simbologia hindu-árabe (1, 2, 3,...), começa na folha a seguir à capa, numa posição central. Não deixar o título de secções ou subsecções isolados no fim de uma página nem começar uma secção referindo-se ao seu título. Evitar que fiquem menos de três linhas, na última página das secções. V. Escrita O texto deve ser escrito no tempo presente e na forma impessoal. Não se deve escrever, Neste texto tratei da forma de como escrevi um relatório, mas antes, por exemplo, Este texto trata da forma de como se deve escrever um relatório. Dar um estilo coerente e uniforme ao relatório, evitando a escrita telegráfica ou literária, isto é, não usando frases muito curtas nem muito longas. Uma boa regra a aplicar é que as frases não devem ocupar mais de três linhas. Deve ser prestada atenção à morfologia e à sintaxe. Todos os valores devem ser apresentados com as respectivas unidades. Deve evitar-se o abuso de adjectivos, excepto quando podem ser quantificados. 2

4 Devem ser banidas expressões vagas do tipo muito bom/mau, bastante aproximado, achamos bem, muito grande/pequeno, muito baixo/alto, etc. numeradas. Deve evitar-se a todo o custo a descrição recorrendo a listas numeradas ou não V.1. Equações e simbologia As equações devem ser centradas e numeradas sequencialmente à direita. Se houver necessidade de ressaltar a existência de um produto, usar o sinal ou um ponto centrado ( ). Os símbolos matemáticos devem ser escritos com um tamanho equivalente ao do texto restante, excepto no que diz respeito a índices, que deverão ser mais pequenos. A tensão Não introduzir uma equação com...na seguinte equação, mas usar, por exemplo U k é determinada por U k n 2π+θ = = k n 2, 25mV. (1) 2 n= 1 n As equações fazem partes de frases, pelo que devem ser colocados ponto final ou vírgula, consoante seja o final de uma frase ou haja uma continuação. Definir sempre os símbolos das equações, na primeira vez que são utilizados. Escrever o mesmo símbolo sempre da mesma forma e não o usar para grandezas diferentes. Os números inferiores à unidade têm de conter sempre o zero à esquerda, usando a vírgula como separador decimal: 0,25, sim,.25 ou 0.25, não. Ter cuidado com algumas aplicações que usam a terminologia anglo-saxónica em que o separador decimal é o ponto. Referir as equações apenas pelo seu número. Por exemplo: Deduz-se de (2) que... ou (3) mostra a dependência com.... No programa Microsoft Word, as equações devem idealmente ser introduzidas usando o programa Mathtype e não o programa de equações incluído no Word. V.2. Figuras e Tabelas Há apenas figuras e tabelas. Não existem nem gráficos, nem quadros, nem fotografias, nem diagramas, nem esquemas. As figuras e as tabelas devem ser numeradas e centradas horizontalmente na página, e uma linha adicional deve ser incluída antes e depois da sua inserção. Todas as figuras e 3

5 tabelas têm que ser introduzidas no texto. A localização das figuras e tabelas tem de ser posterior à sua introdução no texto e o mais perto possível da introdução. A introdução a uma figura ou tabela é explícita, isto é, pela respectiva identificação, pelo que nunca se deve fazer em termos de posição, do tipo figura anterior, tabela da página seguinte, figura abaixo, etc. As figuras e tabelas são numeradas sequencialmente de acordo com a ordem com que aparecem no texto. A legenda das figuras (em Times New Roman e 10 pt) deve vir depois destas (ver Fig. 1), e a das tabelas antes, mas sempre centradas em relação às margens. Por forma a facilitar a numeração, ordenação e referência das legendas deve usar-se no Microsoft Word a opção Insert Caption que surge quando se clica com o botão direito do rato sobre a figura. Para inserir uma referência a uma tabela ou figura deve recorrer-se ao comando Insert Crossreference. Não permitir que as figuras e as tabelas e as respectivas legendas fiquem em páginas diferentes. Se isso acontecer, há várias alternativas que passam pelo redimensionamento das figuras e tabelas, ou inclusão ou remoção de texto antes do seu posicionamento. Quando as figuras ou tabelas não cabem no final de uma página, o texto deve continuar normalmente, sendo colocada a figura ou tabela, na página seguinte. Se uma tabela não couber numa só página (situação a evitar), as páginas de continuação devem conter novamente a legenda, com indicação de continuação. O conteúdo das figuras deve ser claro, e, no caso de conterem gráficos, deve possuir legendas nos dois eixos, indicando quais as grandezas em representação e respectivas unidades. As letras usadas devem ter uma dimensão igual ou inferior (no máximo 2 pt) à dimensão da letra do texto principal. A fonte deverá ser Arial para facilitar a leitura. A qualidade das figuras deve ser tal que não se identifiquem pixels individuais da figura. Não é aceitável inserir figuras feitas no Paint ou programas idênticos. Esquemas e diagramas devem ser feitos no Microsoft Visio ou programa equivalente. Todas as figuras devem ser originais e portanto não podem reutilizadas de relatórios de anos anteriores, da internet ou de outras fontes não referidas. Em último recurso, quando se usam figuras de outras fontes no fim da legenda deve sempre vir indicado por exemplo (retirado de [1]). A Fig. 1(a) é um exemplo de uma má figura porque os eixos não indicam quais as grandezas representadas, e as suas graduações e a legenda são de difícil leitura. Por outro lado, na Fig. 1(b), são indicadas as grandezas representadas e as respectivas unidades, e o tamanho de letra permite uma leitura aceitável da figura. 4

6 (a) (b) , U s [V] , Tempo [ms] Fig. 1 Exemplos de figuras: incorrecto (a) e correcto (b). Nas legendas a fonte deve ser 2 pt inferior ao texto normal. As escalas das figuras 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. Seleccionar com cuidado o número de valores em cada eixo (nunca deverá exceder 6) que não devem conter muitos dígitos significativos. Não repetir o título de um gráfico por cima deste, quando a informação consta da legenda da figura. Os números em tabelas devem vir centrados e com a mesma ordem de grandeza para se poder perceber melhor a sua diferença. Os conteúdos das tabelas devem vir verticalmente centrados nas respectivas células. Os conteúdos das figuras e tabelas devem ser sempre comentados no texto perto das suas localizações. Não permitir que uma referência (por exemplo, Figura 5) se reparta por duas linhas, isto é, Figura, no fim de uma linha e 5, no início da linha seguinte. Para precaver estas situações, devem inserir-se, exactamente antes de Figura 5, espaços adicionais que provoquem a passagem desta palavra para a linha seguinte. O mesmo se aplica em relação às tabelas. No programa Microsoft Word existe um caractér especial que pode ser inserido entre Figura e 5 que garante que não ocorre uma quebra de linha. Esse carácter é o non breaking space e é inserido recorrendo à combinação de teclas Ctrl + Shift +Espaço. Estas instruções aplicam-se também ao espaço entre valores de grandezas e as respectivas unidades. 5

7 VI. Recomendações finais Um relatório demora sempre mais a escrever do que o que se pensa. No final, reler sempre o que se escreveu, várias vezes. As gralhas e erros são mais facilmente detectados por outra pessoa. Por isso, pedir a outra pessoa (por exemplo, outro elemento do grupo) para o fazer e comentar. Repetir o ciclo as vezes necessárias até que o relatório esteja completo e correcto. Procurar no texto expressões ou frases que sejam inúteis para o objectivo do relatório e elimina-las. Se o texto continua a fazer sentido e a explicar tudo o que se pretende transmitir sem um certo conjunto de palavras, então esse conjunto deve ser retirado. O texto deve ser simples e conciso. 6

8 Capa de acordo com o template Margens de acordo com as instruções Checklist Final Número de páginas igual ou inferior a 15 Texto normal em Times New Roman 12 pt Espaço entre linhas a 1 e ½ Texto título das secções em Arial 14 pt com espaçamento de 12 pt antes e 6 pt depois Texto no tempo presente e na forma impessoal Páginas numeradas Capa não numerada Todos os valores com unidades Espaço entre valores e unidades Unidades sem ser em itálico Prefixos escritos de forma correcta Separador decimal, Tabelas e figuras centradas Tabelas e figuras numeradas Tabelas e figuras introduzidas no texto antes da sua posição Legendas e figuras/tabelas na mesma página Conteúdo das tabelas centrado verticalmente Equações centradas Equações numeradas à direita Símbolos todos definidos e apresentados exactamente na mesma forma Texto nas figuras em Arial e legível Texto das legendas em Times New Roman 10 pt Não existem mudanças de linha entre números e unidades Rever todo o conteúdo pelo menos 2 vezes por diferentes pessoas Verificar conteúdo conversão e qualidade do PDF 7