Baixe modelo relatório técnico e outras Trabalhos em PDF para Escrever Relatórios, somente na Docsity!
Universidade Tecnológica Federal do Paraná – UTFPR Departamento Acadêmico de Eletrônica – DAELN Departamento Acadêmico de Informática – DAINF Engenharia de Computação Oficina de Integração 3 (IF66J) – S71 – 2016/
Relatório Técnico
Modelo e instruções para a elaboração dos
relatórios técnicos da disciplina IF66J
Março de 2016
Resumo O resumo deve ter entre 150 e 200 palavras. Apesar de breve, deve fornecer uma visão completa do trabalho. Por isso, é importante mencionar, pelo menos: a motivação para a realização do trabalho, a abordagem para a solução do problema e os resultados obtidos. Recomenda-se redigí-lo so- mente após finalizar todo o documento. Veja em [1] uma descrição mais detalhada do conteúdo esperado em um bom resumo. Quanto à forma, utiliza-se um único parágrafo, acrônimos apenas se realmente necessá- rios e nenhuma referência bibliográfica. Logo, eu não poderia ter incluído aqui o [1], mas esse é o momento de apresentá-lo. Além disso, este resumo não é necessariamente um resumo, mas sim um breve guia para a elabo- ração de um resumo. Se fosse um resumo, estaria apresentando o modelo. Por exemplo:... relatórios técnicos são instrumentos importantes para a comunicação de coisa e tal. Este documento apresenta um modelo para coisa e tal da disciplina Oficina de Integração 3. O editor de texto utilizado é o LATEX e a classe de documento adotada é a article , recomendada para coisa e tal.... Além do título e autores, o resumo também costuma ser uti- lizado para a indexação do documento nas bases de dados. Portanto, é um recurso valioso para o leitor conhecer e julgar o seu trabalho.
1 Introdução
B
Leia todo este documento com atenção. O texto não é apenas placeholder, há instruções e dicas importantes para a elaboração do relatório técnico. Faça seu relatório a partir do arquivo tex deste modelo (abra o tex, faça um ‘Save as’ e mãos à obra).
B
Conteúdos obrigatórios do relatório técnico: 1) figura com a visão geral do projeto; 2) requisitos (sugestão: inserir ambos na seção Introdução); 3) tabela com os custos do projeto (sugestão: inserir na seção Resultados).
Existem inúmeras sugestões de estruturas para a introdução. Há quem diga que não podem faltar o objetivo geral e objetivos específicos , outros exigem uma sub- seção metodologia , outros subseções para o problema e justificativa , e assim vai. Todos estão certos. Mas, no final das contas, basta lembrar que a introdução deve abordar estes três grandes aspectos do projeto: o quê , porquê e como [2]. Isto é o necessário para a que a sua introdução seja suficientemente descritiva, pouco “burocrática” e sem sobreposição de conteúdos. Lembre-se também de mantê-la interessante e de leitura agradável e que não é obrigatório criar subse- ções.
2 Estrutura
A estrutura também é chamada de ‘esqueleto’ do relatório. Recomenda-se que a estrutura completa, ou uma estimativa dela, seja a primeira etapa do processo de elaboração do relatório. Com excessão da introdução e da conclusão , não é obrigatório adotar a estrutura tradicional, que utiliza seções chamadas de fun- damentação teórica e desenvolvimento. É claro que deve existir conteúdo refe- rente a isso, mas não necessariamente com estes nomes. O mesmo vale para a seção resultados (apesar de ser um pouco estranho um relatório técnico sem uma seção resultados ). Veja, por exemplo, como os três artigos a seguir foram organizados.
Integrating hardware and software for the development of microcontroller-based systems [3], 12 páginas, citado 35 vezes [4]. Se estivesse no formato deste modelo teria umas 26 páginas.
- Introduction
- Laboratory facilities (a) Hardware (b) Software
- Course structure
- Teaching laboratory (a) LAB 1: introduction to the development environment (b) LAB 2: structured assembly language programming (c) LAB 3: hardware interfacing (d) LAB 4: parallel I/O (e) LAB 5: interrupt and interrupt handling
- Project laboratories (a) Line tracking robot
Em [7] há boas sugestões de estruturas e outras dicas para a elaboração de um trabalho de conclusão de curso (final year project). Apesar de tratar-se de um guia para a elaboração de um relatório mais extenso, pode fornecer idéias para você criar a estrutura mais adequada para este seu relatório técnico.
3 Redação
Um texto técnico-científico deve ser objetivo, claro e preciso [8]. A seguir você encontra algumas dicas para a redação. No Apêndice 1 de [9] também há dicas interessantes.
- Sempre releia o que acabou de escrever. Pergunte-se se outra pessoa con- seguiria entender a idéia a partir do que você escreveu.
- A concisão é muito importante. Em [8] há uma boa definição de um texto conciso: “é aquele que transmite o máximo de informações com um mí- nimo possível de palavras sem prejuízo da compreensão”.
- Prefira períodos curtos (frases curtas). Períodos longos, se não forem ela- borados cuidadosamente, podem ficar truncados e comprometer a com- preensão.
- Grandiloquência e rebuscamento não combinam com um texto técnico- científico. A prioridade é transmitir a mensagem de maneira clara. Em [8] tem até uma piada sobre isso: “Desnecessário faz-se empregar estilo de escrita demasiadamente rebuscado, conforme deve ser do consentimento de V. Sa. Outrossim, tal prática advém de esmero excessivo que beira o exibicionismo.”
- Em textos técnico-científicos, recomenda-se o uso da terceira pessoa. Por exemplo, ao invés de escrever soldamos as peças , prefira as peças foram soldadas. Este é um tópico polêmico já que é dificil negar que, muitas vezes, o uso da primeira pessoa deixa o texto mais agradável. De qualquer forma, dê preferência para a impessoalidade.
- Conecte as idéias. Reler o que acabou de escrever auxilia na criação de um texto com seqüência lógica. Também, a seguinte dica de [10] pode ajudar: “Antes de iniciar, organize um roteiro com as idéias e a ordem em que elas serão apresentadas. Estabeleça um plano lógico para o texto. Só escreve com clareza quem tem as idéias claras na mente ”. Isso vale também para a estrutura de seções (‘esqueleto’ do relatório).
- Apesar de não ser um texto para leigos, muitas vezes o leitor não possui o mesmo embasamento teórico e técnico que você. Use o bom senso e a sua experiência para decidir que pontos requerem descrições mais deta- lhadas, e em quais deles descrições superficiais são suficientes.
- Palavras estrangeiras provavelmente estarão bastante presentes em um relatório técnico de engenharia. Embora muitas destas palavras já este-
jam presentes no nosso dia-a-dia, na hora de colocá-las no papel, especi- almente em um texto formal, é necessário adotar o itálico. Para saber se uma palavra está incorporada ao português, faça uma busca no vocabulá- rio ortográfico da língua portuguesa da Academia Brasileira de Letras [11]. No entanto, no nosso relatório técnico, podemos ser tolerantes. Por exem- plo, software e hardware não precisam de itálico. Já o termo thread , acho que sim. Agora você deve ter pensado – cacildis, que lambança! Não se desespere, independentemente da unanimidade ou não da necessidade do itálico, o mais importante é manter a consistência ao longo do texto. Então, se é thread , é thread sempre. Se é thread, é thread sempre. Ainda, é possível muitas vezes resolver essa pendenga simplesmente adotanto o termo em português, quando existir, mesmo que pareça estranho. Por exemplo, ao invés de framework , adotar arcabouço. Só pra ilustrar como esta questão gera divergências, a Secretaria de Comunicação do Senado Federal, em suas normas internas, requisita que muitos estrangeirismos sejam grafados sem itálico ou aspas [12].
4 LATEX
Ao contrário da opinião do coelhinho da Figura 1, fazer no LATEX não é tão de- sesperador assim. O LATEX só quer o seu bem e vai te ajudar a preparar um do-
cumento caprichado. Para compilar o arquivo tex do modelo não é necessário
qualquer complemento sty, cls ou bib externo. Use o editor de sua preferên-
cia. Para Windows, o mais difundido é o TeXnicCenter [13]. O TeXstudio [14] parece ser interessante. O WinShell é mais simples [15]. Opinião pessoal: acho o TeXnicCenter poluído e já vi bugs no TeXstudio. Sugiro o WinShell – funciona bem, é fácil de usar e dá conta do recado.
Figura 1: O coelhinho que não queria usar LATEX. Adaptado de [16].
Pra quem nunca usou o LATEX, aí vai um super-ultra-short guide para um Hello World.
Passo 3. Substitua \usepackage[latin1]{inputenc} no preâmbulo, por
\usepackage[utf8]{inputenc}.
Passo 4. Só isso. Nem precisa pedir pra compilar porque o Overleaf gera pre- views (compilações) automaticamente. É possível alterar este comporta- mento do ambiente de Auto para Manual, ao lado da palavra Preview.
Passo 5. Para baixar o pdf correspondente ao preview, clicar em PDF lá em cima.
4.2 Gerenciando e chamando referências
Gerenciar e chamar as referências no LATEX é moleza. Para chamar uma refe-
rência basta usar o comando \cite{minhaRef}, onde minhaRef é o label da
referência. As referências ficam em um arquivo bib, que pode ser gerenciado a
partir do próprio editor ou de aplicativos específicos para isso. O JabRef [20] é um dos mais populares.
- JabRef: http://jabref.sourceforge.net/
O comando \bibliography{meuArquivoBib}, inserido no final do arquivo
tex, antes do comando \end{document}, realiza o link entre os arquivos tex e
bib.
Estão disponíveis diferentes estilos de formatação da lista de referências e
das chamadas. Neste modelo, vamos usar o estilo unsrt do LATEX [21]. O estilo é
especificado utilizando-se o comando \bibliographystyle{unsrt} antes do
comando \bibliography. Importante: no estilo unsrt, para inserir dados adi-
cionais da referência, use o campo note.
Exemplo:
Uma estrutura de artigo científico amplamente aceita é a IMRAD
(introduction, method, results and discussion) \cite{Hartley08}.,
resulta em: Uma estrutura de artigo científico amplamente aceita é a IMRAD (introduction, method, results and discussion) [9].
E, na seção Referências, aparecem os dados da Hartley08 que você inseriu no
arquivo bib:
[9] James Hartley. Academic Writing and Publishing: A Practical Handbook. Taylor & Francis, 2008.
Muitas referências podem ser encontradas na web já prontas para serem in-
seridas no arquivo bib. Para procurá-las, a palavra-chave é BibTeX , que é o fra-
mework de gerenciamento de referências usado pelo LATEX. Tente, por exemplo, googlar “academic writing and publishing” book bibtex.
5 Figuras, tabelas e equações
Atenção para as regras a seguir.
- Figuras e tabelas sempre devem ser chamadas a partir do texto. Para isso, utilize as palavras Figura/Figuras e Tabela/Tabelas com iniciais maiúscu- las.
- O conteúdo das figuras e tabelas deve ser bem explicado.
- Se a figura/tabela não é de sua autoria, cite a fonte após o ponto final da legenda da seguinte forma: ‘Fonte: [referência]’. A referência deve constar na seção Referências, como qualquer outra.
- Se a figura/tabela não é de sua autoria mas você a editou, cite a fonte após o ponto final da legenda da seguinte forma: ‘Adaptado de [referência]’. A referência deve constar na seção Referências, como qualquer outra.
- A legenda de uma figura fica abaixo da figura e a legenda de uma tabela fica acima da tabela.
- Jamais exagere no tamanho de uma figura, especialmente se a intensão for estender o documento artificialmente. Isso não funciona! Qualquer leitor vai notar. Sem falar que compromete a estética e desperdiça re- cursos. Uma estratégia para usar o espaço de forma eficiente e estética é colocar várias figuras relacionadas em uma mesma F igura (‘Figura x ’ do documento), na forma de um grid. Na Figura x , estas figuras são agora subfiguras que podem ser indexadas por (a), (b)... ( n ). Todas as subfi- guras devem ser mencionadas na legenda e, de preferência, também no texto.
- Tabelas são abertas nas laterais, isto é, não possuem bordas externas es- querda e direita.
- Equações sempre devem ser chamadas do texto, mas não é obrigatório usar a palavra Equação/Equações. Na chamada de equações, também não é obrigatório usar o índice (número identificador localizado à direita) da equação. Quando a equação for inserida diretamente no corpo do pa- rágrafo, junto com o texto, esta equação não recebe um índice.
- Todos os elementos das equações (variáveis) devem ser explicados. Uma vez que aparecem diretamente no corpo do parágrafo, junto com texto, devem estar em itálico para serem facilmente discriminados.
- Equações que não são da sua autoria também devem ser referenciadas. A referência ([referência]) fica no texto, próxima da chamada da equação. Mas sempre vale o bom senso. Por exemplo, a equação da velocidade, v = s / t , onde s é o espaço e t é o tempo, não precisa de referência. Observe que esta equação foi inserida diretamente no corpo do parágrafo, junto com o texto. Neste caso, ela não é identificada com um índice.
A seguir é apresentado um exemplo envolvendo equação, tabela e figura.
(a) (b) (c) (d)
Figura 2: Exemplos de seres vivos que utilizam sistemas numéricos de diferentes bases. (a) humanos: base 10, (b) Simpsons: base 8, (c) caranguejos: base 4 e (d) golfinhos: base
Tabelas mais sofisticadas podem às vezes ser um pouco chatas de se fazer no LATEX, mas depois de pegar o jeito fica fácil. A Tabela 2 apresenta o número de títulos em diferentes campeonatos de times de futebol do Cazaquistão 1. Observe que ela utiliza o recurso de ‘mesclar células’ (termo usado pelo editor
MS Word), obtido no LATEX a partir dos comandos \multirow e \multicolumn.
Tabela 2: Número de títulos em campeonatos nacionais e internacionais dos times mais populares do Cazaquistão.
Divisão Time Camp. Nacional^ Camp. Internacional Copa do Rei Brasileirão Libertadores Champions
1 a^ Águias^12 2 0 KZAQs 7 1 1 0 2 a^ Powers π
p 2 0 1
6 Professor, quantas páginas?
Só pra ter uma referência, vamos considerar os padrões de algumas revistas ci- entíficas, que estabelecem um mínimo de 3000 ou de 5000 palavras para o corpo do texto, dependendo do tipo de artigo. Se adotássemos as normas para elabo- ração trabalhos acadêmicos da UTFPR [23] – fonte Times 12 pt, espaçamento 1,5, margens esquerda e superior de 3 cm, margens direita e inferior de 2 cm
- 3000 palavras ocupariam umas 7 páginas e 5000 palavras ocupariam umas 12 páginas. Apesar de parecer mais compacto, no nosso modelo os números de pá- ginas seriam os mesmos (observe que, apesar da fonte 11 pt e espaçamento sim- ples, as margens são grandes). Como ainda existem os elementos pré-textuais, referências, figuras e os espaçamentos entre as seções, o número de páginas
(^1) Claro que a tabela é fake. Isto é uma nota de rodapé, obtida com o comando \footnote{Meu texto aqui.}
certamente aumenta. Vamos considerar, por exemplo, que um relatório de 3000 palavras ocupe então 10 páginas. Esta é uma faixa de números de palavras e páginas compatível com o que esperamos para a disciplina. Outro dado interes- sante com relação à extensão deste tipo de documento pode ser encontrado em [7], que estabelece um limite de 15000 palavras para o corpo do texto de um re- latório de trabalho de conclusão de curso. Com base em tudo isso, vamos então estabelecer as regras para o relatório técnico da IF66J:
- Mínimo de 3500 e máximo de 6000 palavras, contadas a partir do arquivo pdf, utilizando uma das ferramentas a seguir. - Translator’s Abacus (free):
http://www.globalrendering.com/download.html
- WordCounter online word counter:
http://www.docwordcounter.com/
- Count On It online word counter:
http://felix-cat.com/tools/wordcount/ (talvez pdf limitado em
1 MB)
Não é possível afirmar que estas ferramentas apresentam contagens exa- tas, mas é o suficiente para as nossas necessidades. Ainda, as contagens de cada ferramenta não são idênticas. Este pdf por exemplo, segundo o Translator’s Abacus possui 4534 palavras e segundo o WordCounter, 4433 palavras. Adote aquela da sua preferência ou, se for necessário, aquela que resulta em uma contagem mais conveniente para a sua situação.
- Mínimo de 10 e máximo de 15 páginas.
- Mínimo de 4 figuras.
- Mínimo de 10 referências.
7 Antes de enviar para os professores
Não envie para os professores da disciplina um relatório inacabado, ou em ou- tras palavras, mal feito. Certamente você tem experiência e bom senso pra saber quando o documento está decente e adequado para ser apresentado aos pro- fessores. Sabemos que você sabe, mas não custa reforçar que o trabalho é da equipe. Os professores requisitarão correções e melhorias, mas não tem super- poderes para transformar um relatório muito ruim em bom. Assim, é importante sempre fazer revisões. No Apêndice 2 de [9] há um ex- celente guia para a revisão detalhada de um texto técnico-científico (conteúdo e estrutura). Outra abordagem que pode auxiliar na melhoria do texto é uma autoavaliação segundo critérios bem específicos. Veja a seguir alguns critérios utilizados pelos revisores (peer review) dos artigos científicos de dois congres- sos diferentes. Observe que estes critérios poderiam ser aplicados também na avaliação de um relatório técnico.
- Presentation – References (number and quality)
- Presentation – Title concise and informative
- Presentation – Abstract (objective, scope, results)
- Presentation – Adequate length
- General – Overall quality rating
8 Sugestões para os professores
Por favor, fique à vontade para fazer sugestões para o aperfeiçoamento de qual- quer aspecto deste modelo, em qualquer momento. Comentários pertinentes serão sempre bem vindos. Valorizamos sinceramente o seu retorno e interesse em contribuir.
9 Conclusão
Outros nomes possíveis para esta seção são Considerações finais ou Conclusões (no plural). Deve apresentar um panorama geral do projeto com ênfase no que foi atingido, mencionando-se os principais objetivos, seus resultados e o que foi aprendido [7]. Seja objetivo e mantenha o foco nos aspectos técnicos, de preferência incluindo dados quantitativos. Costuma-se também apresentar su- gestões de trabalhos futuros , isto é, o que pode ser feito para a continuidade do projeto. O relatório será avaliado pelos professores da disciplina e por uma banca e conta pontos importantes. Lembre que a banca não acompanhou a execução do projeto. Na maioria dos casos, é por meio do relatório que acontece o primeiro contato dos julgadores com o seu trabalho. Portanto, é essencial deixar uma boa impressão e valorizar o seu projeto. Um bom trabalho pode facilmente ser ofuscado por um relatório pobre ou descuidado. A versão final deste documento permanecerá à disposição das pessoas. É ex- clusivamente através dele que o seu trabalho será julgado por aqueles que não viram o protótipo ou não acompanharam a defesa. O objetivo é que o relatório sirva como uma fonte de pesquisa, referência ou inspiração para pessoas inte- ressadas na área do seu projeto, ou até mesmo em reproduzí-lo ou aperfeiçoá-lo. Por fim, tenha em mente que a prioridade é a qualidade do relatório e não a sua extensão, isto é, qualidade e não quantidade. Ao mesmo tempo, não deve ser muito curto, comprometendo a completude. Bom senso sempre e bom tra- balho!
B
Este modelo foi redigido em uma linguagem muitas vezes informal, o seu relatório deve ser formal. Neste modelo não houve preocupação em usar o itálico para termos estrangeiros, no seu relatório deve haver.
Agradecimentos
Esta seção é opcional. Mencione colegas, parentes, professores, fornecedores, chineses ‘craqueadores’ de softwares ou quaisquer outras pessoas/entidades, humanas ou não, a quem você queira manifestar sua gratidão. Observe que esta
seção não é numerada (comando \section*{Agradecimentos}).
Referências
[1] Philip Koopman. How to write an abstract, 1997. http://users.ece.cmu.
edu/~koopman/essays/abstract.html.
[2] Mudathir Funsho Akorede. Guidelines for writing an undergraduate engi- neering project. IEEE Potentials , 28(6), 2009.
[3] A.H.G Al-Dhaher. Integrating hardware and software for the develop- ment of microcontroller-based systems. Microprocessors and Microsystems , 25(7):317 – 328, 2001.
[4] Google Scholar. scholar.google.com.
[5] Gerwin Schalk et al. Bci2000: a general-purpose brain-computer interface (BCI) system. IEEE Trans Biomed Eng , 51:1034–43, 2004.
[6] J. Levinson et al. Towards fully autonomous driving: Systems and algo- rithms. In IEEE 2011 Intelligent Vehicles Symposium (IV) , pages 163–168, June 2011.
[7] Cardiff University – School of Computer Science and Informatics. A short guide to writing your final year project or MSc dissertation, 2011.
Download: https://www.cs.cf.ac.uk/PATS2/wiki/lib/exe/fetch.
php?media=project-report.pdf.
[8] Rui Alexandre Generoso. Estrutura e redação de um texto técnico-
científico. Download: http://www.ruyalexandre.hol.es/arquivos/
pedtextocientifico.pdf.
[9] James Hartley. Academic Writing and Publishing: A Practical Handbook. Taylor & Francis, 2008.
[10] Blog Pós-Graduando. Dez erros comuns na redação científica, 2010.
http://posgraduando.com/blog/dez-erros-comuns-na-redacao-
cientifica.
[11] Academia Brasileira de Letras – Busca no vocabulário. http://www.
academia.org.br/abl/cgi/cgilua.exe/sys/start.htm?sid=23.
