EEX23 Modelo RelatTecnicoLaTeX

Fazer download em pdf ou txt
Fazer download em pdf ou txt
Você está na página 1de 15

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 (EEX23) – S71 – 2020/1

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).

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.
1. Introduction
2. Laboratory facilities
(a) Hardware
(b) Software
3. Course structure
4. Teaching laboratory
(a) LAB 1: introduction to the development environment
Relatório Técnico: Modelo 3

(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
5. Project laboratories
(a) Line tracking robot
(b) Infrared communication project
6. Student reactions and difficulties
7. Future expansion
8. Conclusion

BCI2000: A general-purpose brain-computer interface (BCI) system [5], 10 pági-


nas, citado 1020 vezes [4]. Se estivesse no formato deste modelo teria umas 22
páginas.
1. Introduction
(a) Brain-computer interface (BCI) technology
(b) Further development of BCI technology
2. BCI2000 system design
(a) Essential features
(b) Modules
(c) System variables
3. Initial implementations of BCI2000
(a) Plataform
(b) Modules
4. Evaluation and validation of BCI2000
(a) Real-time capabilities
(b) Online performance
5. Discussion
(a) Summary
(b) Benefits of BCI2000
(c) Future development of BCI2000
6. Availability of BCI2000 to other research groups
7. Future expansion
8. Conclusion

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

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).
Relatório Técnico: Modelo 5

• 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.

Passo 1. Instale a distribuição MiKTeX do TEX/LATEX.


• MiKTeX: http://miktex.org (Basic MiKTeX Installer)

Passo 2. Instale o editor de sua preferência. Dizem que o TeXnicCenter está


funcionando bem.
• TeXnicCenter: http://www.texniccenter.org/
Relatório Técnico: Modelo 6

Figura 1: O coelhinho que não queria usar LATEX. Adaptado de [16].

Passo 3. Abra o TeXnicCenter → menu File → New → TeX-Document. Insira o


código a seguir [17] e depois compile: menu Execute → LaTeX. Será gerado
um pdf com o mesmo nome e no mesmo diretório do arquivo tex.

\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,

4.1 Editor online Overleaf


Além dos editores mencionados, há ainda os editores online. Apresentam as fa-
cilidades de dispensar a instalação do MiKTeX e de um editor na sua máquina, já
conter todos os packages, armazenamento confiável, fácil acesso a diversas op-
ções de templates, e a possibilidade de compartilhar o documento com outras
pessoas, o que facilita bastante os trabalhos em equipe. O editor online mais
difundido é o Overleaf [15].
• Overleaf: https://www.overleaf.com
Para transferir este documento para o Overleaf, após fazer o cadastro:
Relatório Técnico: Modelo 7

Passo 1. Clique em New Project e, na lista de opções, clique em Upload Project.

Passo 2. Na janela Upload Zipped Project, suba um zip contendo os arquivos


necessários para o LATEX fazer a compilação: arquivo tex, arquivos das
figuras e arquivo bib com a bibliografia. Para o presente documento, por
exemplo, o EEX23_Modelo_RelatTecnicoLaTeX.zip já está organizado
pra isso.

Passo 3. Substitua \usepackage[latin1]{inputenc} no preâmbulo, por


\usepackage[utf8]{inputenc}, se for o caso.

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.

Passo 5. Para baixar o pdf correspondente ao preview, clicar no ícone de uma


seta para baixo. Ao passar o mouse neste ícone aparece ’Download PDF’.

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 [18] é
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 [19]. 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:
Relatório Técnico: Modelo 8

[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 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.

A seguir é apresentado um exemplo envolvendo equação, tabela e figura.


Para acompanhar melhor o exemplo, sugere-se observar também como ele foi
escrito em LATEX. Basta abrir o arquivo EEX23_Modelo_RelatTecnicoLaTeX.tex,
disponível no EEX23_Modelo_RelatTecnicoLaTeX.zip. Lembrando que o ar-
quivo zip está pronto para upload e compilação no Overleaf [15].

“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

onde a é o algarismo e p é a posição do algarismo dentro do numeral a ser con-


vertido, sendo p = 0 para o algarismo mais da direita, denominado menos signi-
ficativo (para as definições de número, numeral e algarismo, veja [20]).”

Outra opção seria:

“Na notação posicional, um numeral inteiro de base b qualquer pode ser


convertido para a base 10 conforme a Equação 1, onde a é o algarismo e p é a
posição do algarismo dentro do numeral a ser convertido. p = 0 para o algarismo
mais da direita, denominado. . . .”
Para equações diretamente no corpo do parágrafo, junto com o texto, utilize
o recurso de equações inline do LATEX. Uma das maneiras de se fazer isso é co-
locando a equação e/ou seus elementos dentro de $$. Por exemplo:

$y=x+c$, onde $c$ é uma constante, resulta em:


y = x + c, onde c é uma constante.

Continuando com o exemplo:

“A Tabela 1 apresenta os símbolos adotados em sistemas numéricos de diferen-


tes bases b. O sistema numérico decimal (base 10) tem sua origem no fato de
possuirmos 10 dedos nas mãos. A Figura 2 mostra exemplos de seres vivos que
utilizam os sistemas numéricos da Tabela 1. Observe que os golfinhos (Figura
2(d)) usam o sistema numérico binário, o mesmo dos computadores.”
Não tente brigar com o LATEX para posicionar as figuras e tabelas onde você
Relatório Técnico: Modelo 10

Tabela 1: Símbolos adotados em sistemas numéricos de diferentes bases b.

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

(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
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.

Tabela 2: Número de títulos em campeonatos nacionais e internacionais dos times


mais populares do Cazaquistão.

Camp. Nacional Camp. Internacional


Divisão Time
Copa do Rei Brasileirão Libertadores Champions
Águias 12 2 0 0
1a
KZAQs 7 1 1 0
p
2a Powers π 2 0 1

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

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 [21] – 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
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 EEX23:
• 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-
Relatório Técnico: Modelo 12

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.

7.1 Conjunto de critérios #1


1. Technical soundness (Are the ideas developed in a correct way?)
(a) Completely correct
(b) Probably correct (some minor points not clear)
(c) Has only minor errors
(d) Not enough details to judge
(e) Has major errors (please justify)
2. Presentation (Is the paper well written? Is it clear, well organized?)
(a) Excellent, paper is clear and well written
(b) Very good, but it can be improved is small points
(c) Good, but has minor errors in writing and/or figures
(d) Weak, with lots of minor errors in writing and/or figures
(e) Unreadable (please justify)
3. Overall recommendation (How do you classify this paper in a single grade?)
(a) Accept for Oral Presentation
(b) Accept for Poster Presentation
(c) Reject

7.2 Conjunto de critérios #2


1. Overall evaluation
(a) strong accept
(b) accept
(c) weak accept
(d) borderline paper
(e) weak reject
(f) reject
(g) strong reject
Para todos os critérios a seguir, as pontuações são:
(a) excellent
(b) good
(c) fair
Relatório Técnico: Modelo 13

(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

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
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.

[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.
Relatório Técnico: Modelo 15

[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.

[12] Senado Federal. Manual de comunicação da Secom. http:


//www12.senado.gov.br/manualdecomunicacao/redacao-e-
estilo/estilo/estrangeirismos-grafados-sem-italico.

[13] TeXnicCenter integrated documentation environment (IDE) for LaTeX.


www.texniccenter.org/.

[14] WinShell LaTeX user front end. http://www.winshell.de/.

[15] Overleaf collaborative writing and publishing. https://www.overleaf.


com/.

[16] Andy Riley. The Book of Bunny Suicides. Plume, 2003.

[17] Mike Unwalla. LaTeX: an introduction. Communicator, Spring 2006.


Download: http://www.techscribe.co.uk/ta/latex-introduction.
pdf.

[18] JabRef open source bibliography reference manager. http://jabref.


sourceforge.net/.

[19] Lapo F. Mori. Managing bibliographies with LaTeX. TUGboat, 30(1):36–48,


2009. Download: https://www.tug.org/TUGboat/tb30-1/tb94mori.
pdf.

[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.

[21] Universidade Tecnológica Federal do Paraná (UTFPR) – Comissão


de Normalização de Trabalhos Acadêmicos. Normas para elabo-
ração de trabalhos acadêmicos, 2008. Download: http://www.
utfpr.edu.br/dibib/normas-para-elaboracao-de-trabalhos-
academicos/normas_trabalhos_utfpr.pdf.

Você também pode gostar