EEX23 Modelo RelatTecnicoLaTeX
EEX23 Modelo RelatTecnicoLaTeX
EEX23 Modelo RelatTecnicoLaTeX
Relatório Técnico
Modelo e instruções para a elaboração dos
relatórios técnicos da disciplina EEX23
Primeironome N. M. Ultimonome 1 – [email protected]
Primeironome N. M. Ultimonome 2 – [email protected]
Primeironome N. M. Ultimonome n – [email protected]
Fevereiro de 2020
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
"
Os arquivos para a compilação deste documento LATEX estão disponíveis no arquivo
compactado EEX23_Modelo_RelatTecnicoLaTeX.zip, que contém:
EEX23_Modelo_RelatTecnicoLaTeX.tex (arquivo fonte LATEX), EEX23_v1.bib
(blibliografia), e cinco arquivos png (figuras). O arquivo zip está pronto para upload e
compilação no Overleaf (detalhes sobre o Overleaf na seção 4.1). Assim, a leitura deste
pdf pode ser acompanhada da consulta ao código fonte LATEX em
EEX23_Modelo_RelatTecnicoLaTeX.tex. Isto tornará a leitura mais informativa
contribuirá para o progresso da sua familiarização com o LATEX.
1
Relatório Técnico: Modelo 2
"
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).
"
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).
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.
Towards fully autonomous driving: systems and algorithms [6], 6 páginas, citado
75 vezes [4]. Se estivesse no formato deste modelo teria umas 14 páginas.
1. Introduction
2. System and vehicle
(a) Hardware
(b) Software
3. Unsupervised laser calibration
4. Mapping and localization
5. Object recognition
Relatório Técnico: Modelo 4
6. Trajectory planning
7. Dynamical modeling and control
8. Traffic light detection
9. Generic sign detection and direction-invariant stop sign classification
10. Conclusion
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.
• 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 WinShell é mais
simples [14]. Já o Overleaf [15] é um editor online.
Pra quem nunca usou o LATEX, aí vai um super-ultra-short guide para um
Hello World usando o editor TeXnicCenter. Também é possível e até mais reco-
mendável usar um editor online, já que você vai trabalhar em equipe. A seção
4.1 apresenta o Overleaf.
\documentclass{article}
\begin{document}
A \textbf{bold \textit{Hello \LaTeX}} to start!
\end{document}
Fora isso, com um pouquinho de boa vontade e muito Google você fica cra-
que em pouco tempo. A propósito [17]:
• LATEX pronuncia-se ‘lay-tech’ ou ‘lah-tech’.
• O Comprehensive TEX Archive Network (CTAN), http://www.ctan.org, é
o repositório oficial de código e documentação do LATEX.
• O livro mais recomendado é o The LaTeX Companion, Frank Mittelbach e
Michel Goossens, 2nd ed., 2004. Tem 1120 páginas!
• Para o primeiro contato, um material bastante recomendado é o The Not
So Short Introduction to LATEX2e, Tobias Oetiker, 2014. Disponível em http:
//www.ctan.org/tex-archive/info/lshort/english,
Passo 4. Só isso. Nem precisa pedir pra compilar porque o Overleaf gera pre-
views (compilações) automaticamente. É possível alterar este compor-
tamento do ambiente clicando na seta à direita da palavra Recompile e
escolhendo a opção desejada na lista.
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.
• 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 Figura (‘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.
Relatório Técnico: Modelo 9
• 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.
“Na notação posicional, um numeral inteiro de base b qualquer pode ser con-
vertido para a base 10, conforme
n
ap b p ,
X
S [10] = (1)
p=0
b Nome Símbolos
10 decimal 0,1,2,3,4,5,6,7,8,9
8 octal 0,1,2,3,4,5,6,7
4 quaternário 0,1,2,3
2 binário 0,1
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
2.
acha melhor, deixe que ele distribua e relaxe. As chamadas são feitas facilmente
utilizando-se os comandos \label{meuLabel} dentro do ambiente da figura,
tabela ou equação e \ref{meuLabel} no texto. Não altere o tamanho (\small)
da fonte das legendas do modelo tex.
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.
1 Claro que a tabela é fake. Isto é uma nota de rodapé, obtida com o comando \footnote{Meu
texto aqui.}
Relatório Técnico: Modelo 11
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.
(d) poor
(e) very poor
2. Technical Content – Scientific relevance/importance (research or engine-
ering)
3. Technical Content – Methodology
4. Technical Content – Results and data analysis
5. Technical Content – Discussion and conclusion
6. Technical Content – Technical soundness/plausibility
7. Presentation – Clarity of problem statement and objective
8. Presentation – Quality and size of illustrations
9. Presentation – Clarity of writing, standard of language
10. Presentation – References (number and quality)
11. Presentation – Title concise and informative
12. Presentation – Abstract (objective, scope, results)
13. Presentation – Adequate length
14. General – Overall quality rating
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
Relatório Técnico: Modelo 14
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!
"
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 que vendem no DX 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.
[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.
[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.
[20] J.F. Porto da Silveira. Três noções numéricas básicas: número, numeral e al-
garismo, 2001. http://www.mat.ufrgs.br/~portosil/passa7a.html.