IF66J Modelo RelatTecnico
IF66J Modelo RelatTecnico
IF66J Modelo RelatTecnico
Relatório Técnico
Modelo e instruções para a elaboração dos
relatórios técnicos da disciplina IF66J
Primeironome N. M. Ultimonome 1 – emailpessoal1@qqrlugar.com
Primeironome N. M. Ultimonome 2 – emailpessoal2@qqrlugar.com
Primeironome N. M. Ultimonome n – emailpessoaln@qqrlugar.com
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).
1
Relatório Técnico: Modelo 2
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).
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
6. Trajectory planning
7. Dynamical modeling and control
8. Traffic light detection
9. Generic sign detection and direction-invariant stop sign classification
10. Conclusion
Relatório Técnico: Modelo 4
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.
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.
\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,
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.
Relatório Técnico: Modelo 8
• 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.
• 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
Não tente brigar com o LATEX para posicionar as figuras e tabelas onde você
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.
Relatório Técnico: Modelo 10
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.
texto aqui.}
Relatório Técnico: Modelo 11
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.
Relatório Técnico: Modelo 14
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.
[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.