Como redigir um relatório de estágio
Pedro Vasconcelos
[email protected]
Departamento de Ciência de Computadores
Faculdade de Ciências da Universidade do Porto
2 de Março de 2009
1 Introdução
docentes. Também poderá interessar aos orientado-
Este texto pretende servir de guia na elaboração
que, por exemplo, pretendam fazer um estágio na
do relatório de estágio para alunos das licenciatu-
mesma instituição.
res e possivelmente a outros alunos de licenciatura
ras em Ciência de Computadores e Engenharia de
Redes e Sistemas Informáticos.
simultaneamente
pedagógico
e
Todos estes potenciais leitores partilham uma
O objectivo é ser
base de formação cientíco-tecnológica, embora não
proláctico :
dar su-
necessariamente com a mesma profundidade ou na
gestões práticas benécas e chamar a atenção para
mesma área. Assim, ao redigir o relatório deve evi-
potenciais problemas.
tar explicações detalhadas de conceitos elementares
(e.g. a importância das bases de dados) e concentre-
1.1 O que é um relatório?
se na especicidade do seu trabalho (e.g. recolha de
Um relatório é um documento que descreve em de-
produzir relatórios clínicos). Inclua uma referência
talhe um trabalho técnico, como uma experiência
bibliográa de base para ajudar os leitores sem for-
cientíca ou a implementação de uma tecnologia.
mação na área. Isto tem duas vantagens: torna o
No contexto da disciplina de Estágio, o relatório é
texto mais sucinto e evita aborrecer os potenciais
escrito pelo aluno no nal do semestre como uma
leitores.
informações de uma base de dados relacional para
síntese do trabalho efectuado na instituição de acolhimento.
Um relatório
ou biográca :
2 Conselhos de redacção
não é uma obra artística, literária
o texto deve ser conciso, claro e di-
2.1 Estrutura global
recto, com o mínimo de elementos supéruos, quer
não deve ser
a colecção de toda a informação recolhida ou a lis-
de conteúdo quer de estilo. Também
tagem completa dos programas desenvolvidos.
Deve seguir uma estrutura hierárquica em secções
Se
e sub-secções.
Use apenas dois ou três níveis de
achar oportuno incluir listagens, faça uma selecção
numeração de secções: secções, sub-secções e (pos-
de excertos representativos das soluções que usou.
sivelmente) sub-sub-secções.
Também
uma sobrecarga burocrática que não se justica
não é um manual de utilização :
embora
possa descrever a utilização de um ou mais progra-
Mais níveis impõem
para um relatório.
mas implementados, coloque a ênfase nas tecnolo-
Planeie as secções que vai usar antecipadamente,
gias e métodos que usou.
escrevendo os cabeçalhos primeiro e preenchendo o
texto depois. A estrutura típica poderá ser:
1.2 Quem lê o relatório?
Capa:
O relatório de Estágio serve como um dos elementos
Título/Autor/Data;
Agradecimentos:
de avaliação da disciplina e como tal será lido pelos
1
(01 pág.);
Secção 1:
(25 pág.)
2.2 Frases e parágrafos
Introdução/descrição do
problema;
Secção 2:
(210 pág.)
As duas unidades fundamentais de texto são a
e o
Descrição do estado-da-
frase
Um parágrafo é uma sequência de
frases em que o uxo de discurso está encadeado.
arte/tecnologias a usar;
Secção 3:
parágrafo.
Deve-se começar um novo parágrafo apenas quando
se interrompe este uxo.
(520 pág.) Implementação;
Quando se escreve um documento num processador de texto é necessário ter em conta como
Secção 4:
(520 pág.) Exemplos/Resultados;
Secção 5:
(25 pág.) Conclusões;
e quando se introduzem as quebras de parágrafo.
Não deve introduzir parágrafos só porque quer uma
Apêndices:
mudança de linha: o parágrafo é uma unidade de
estrutura do texto, não é um elemento de formatação visual. Se usar um processador de texto WY-
(120 pág.) Bibliograa, excertos de
1
Apenas a introdução e conclusão são obrigatórias;
Microsoft Word ou Open Oce
Writer, pode usar a opção View Nonprinting characters para visualizar os espaços com `·' e as que-
as outras secções poderão ser modicadas conforme
bras de parágrafo com `¶'.
SIWYG , como o
listagems.
o caso. Tenha como objectivo um relatório com 40
Não escreva frases demasiado longas; um pará-
páginas mais os apêndices, num máximo de 80100
grafo não deve ser uma única frase sem quebras.
páginas no total.
Use os sinais de pontuação (`,' `;' `:' `.') para se-
Reserve os agradecimentos para pessoas e insti-
parar frases. A vírgula marca uma pausa ligeira na
tuições que contribuiram directamente para o seu
leitura, o ponto-e-vírgula marca uma pausa maior
trabalho, e.g. alguém que o ajudou a instalar um
e o ponto-nal marca o m duma frase. Uma re-
programa ou lhe facultou bibliograa. Os agrade-
gra simples (mas não infalível) para decidir onde
cimentos não são uma dedicatória: não faz sentido
se deve introduzir uma vírgula é ler a frase em voz
agradecer aos seus pais por o terem colocado no
alta: se necessitar de fazer uma pausa num determi-
mundo. . . .
nado ponto, deve introduzir a vírgula; senão, pode
A introdução deve descrever claramente os
tivos
objec-
omiti-la.
do seu trabalho de estágio (e.g. extender uma
2.3 Discurso e tempo verbal
base de dados hospitalar para produzir relatórios
clínicos). Deve também aproveitar para enquadrar
Como o trabalho de estágio é individual, tanto pode
esse trabalho no contexto da instituição de acolhi-
escrever na primeira pessoa do singular como na
mento (e.g. como surgiu a necessidade da base de
primeira pessoa do plural (usando o plural majes-
dados, que entidades a utilizam, porque é útil pro-
tático):
duzir os relatórios).
1a pessoa do singular:
A descrição de tecnologias e implementação deve
focar os
métodos e ferramentas
que usou para atin-
eu ]
Neste trabalho [
im-
plementei uma base de dados relacional. . . gir os objectivos propostos: linguagens de progra-
1a pessoa do plural:
mação, bibliotecas, gestores de base de dados, etc.
nós ]
Neste trabalho [
im-
plementamos uma base de dados relacional. . . Se o trabalho envolver comparação de tecnologias
alternativas, deve descrevê-las nesta secção.
O que não deve fazer é variar entre o singular e o
As escolhas de tecnologia são muitas vezes dita-
plural no mesmo documento.
das pelo orientador ou pela necessidade de integra-
A excepção a esta
regra é usar o singular para trabalho indidivual e o
ção em sistemas existentes; descreva essas opções
plural para o trabalho do grupo em que se insere.
como um ponto de partida para o seu trabalho, mas
Tenha o cuidado de usar um tempo verbal consis-
não as tente racionalizar com argumentos falaciosos
tente. Como o relatório descreve trabalho passado,
(e.g. não escreva usamos a linguagem X porque su-
o mais natural será usar o pretério perfeito:
porta modularidade, uma vez que haveria muitas
1 Acrónimo
outras alternativas igualmente modulares).
2
para
What You See Is What You Get
.
Pretérito perfeito:
Neste trabalho
2.8 Traduções
implementei
neces-
uma base de dados relacional. Para tal,
sitei
Muitos termos técnicos em inglês não têm (ainda?)
das seguintes tecnologias. . . Presente:
Neste trabalho
de dados relacional.
tradução estabilizada em português.
implemento uma base
necessito das
xar os termos na língua de origem tipografados
Para tal,
em itálico ou entre aspas:
seguintes tecnologias. . . rewall, pipeline, etc.
2.4 Voz activa e passiva
As conclusões do relatório devem descrever de que
voz passiva. Compare estas duas frases:
forma os objectivos originais foram (ou não) atingidos. Alguns conselhos sobre como as redigir:
As grandes diculdades encontra-
das foram sobretudo duas.
Voz activa:
software, thread, kernel,
2.9 Conclusões
Um dos erros de escrita mais comums é o abuso da
Voz passiva:
Em vez de
tentar improvisar uma tradução, será preferível dei-
•
É melhor ser factual do que fazer julgamentos
de valor: um relatório deve
Encontramos sobretudo duas gran-
relatar
o que fez
e não julgar se o trabalho foi brilhante, medi-
des diculdades.
ano ou mau. Diga claramente o que funcionou
A primeira frase coloca a ênfase sobre as diculda-
e que o não funcionou, o que correu bem ou
des, enquanto a segunda coloca a ênfase no autor
menos bem.
(
nós
encontramos). A voz activa dá mais prota-
•
gonismo ao autor e ao seu trabalho, e resulta num
O relatório é redigido no nal do semestre
mas não necessariamente no nal do projecto.
discurso mais directo e numa frase mais curta.
Se for caso disso, indique possiveis desenvolvimentos futuros do seu trabalho.
2.5 Referências indirectas
•
Não torne as suas conclusões demasiado sub-
Não abuse de referências indirectas como o que,
jectivas: evite os adjectivos e advérbios como
as quais, estes ou os mesmos. Tornam o texto
imenso, vasto ou grandemente para clas-
difícil de seguir ou mesmo âmbiguo. Em nenhum
sicar o seu trabalho.
caso comece uma frase com O que. . . auto-elogio (surte geralmente o efeito oposto).
ou E
ainda. . . .
•
Evite a tudo custo o
Evite um discurso apologético desculpando-se
com a falta de experiência: estranho seria que
2.6 Listas e itemização
já tivesse experiência antes do estágio! Em vez
disso, realce o que apreendeu e o que teria feito
Para descrever sequências de tópicos pode optar
de maneira diferente se começasse o trabalho
por usar listas itemizadas, mas com moderação:
de novo.
cada lista deve ter pelo menos dois items e menos de que dez. Não use listas dentro de listas: é
melhor hieraquizar as denições e listar conceitos
2.10 Bibliograa
subordinados separadamente.
Inclua uma lista de bibliograa nos apêndices. As
entradas devem ser numeradas para fácil referên-
2.7 Figuras e tabelas
cia no texto.
No caso de citar livros ou artigos
cientícos deve incluir título, autor, ano e editora
Web
Elementos soltos como guras e tabelas deve ser nu-
(e.g. [1]).
merados e etiquetados com uma legenda. Pondere
título descritivo, autor e o URL (e.g. [2])
Para páginas de
deve incluir um
bem a inclusão de guras no meio do texto: além de
2.11 Ortograa
reduzirem o espaço, interrompem o uxo de leitura.
Inclua apenas as guras que realmente contribuem
para o acompanhamento do texto. Figuras ou ta-
Use sempre um corrector automático de ortograa
belas extra devem ser colocadas nos apêndices.
antes de entregar o relatório: mesmo que não seja
3
Romano ABCDabcdefghij
Itálico ABCDabcdefghij
Negrito ABCDabcdefghij
Máquina ABCDabcdefghij
corpo do texto
gens de janelas duma aplicação).
ênfase
corpo do texto, cabeçalhos ou rodapé: não só enca-
cabeçalhos
rece a custo de impressão como pode mesmo dicul-
programas
tar a leitura. Lembre-se que nem todas as pessoas
Não use côr no
vêm todas as cores (daltonismo).
Tabela 1: Sugestões de estilos para texto
3.4 Margens e justicação
perfeito, detecta muitos erros simples sem esforço.
Evite a tentação de reduzir as margens para colo-
Pode usar o dicionário português do
car mais palavras por página. Cada linha deve ter
ispell
AT X e o dicionário português-brasileiro do
L
E
com o
Open Oce Writer.
com o
myspell
cerca de 60 a 66 caracteres; mais caracteres por linha tornam a leitura difícil e requerem um maior
espaçamento entre linhas.
Também não use mais
3 Conselhos de tipograa
de 45 linhas de texto por página. Com um compri-
3.1 Formato e encadernação
dão um máximo de 400500 palavras por página.
mento médio de 5 letras por palavra, estes limites
Na prática, a página terá muito menos palavras
por causa do espaço para cabeçalhos e guras.
O relatório deve ser formatado em páginas A4, com
tamanho de letra 11pt. As páginas, secções e gu-
Recomenda-se a justicação a ambas as margens.
ras devem ser numeradas.
Justicar apenas à esquerda (como neste
Recomenda-se a impressão em papel reciclado
paragráfo) torna mais difícil detectar a quebra de
branco em frente-e-verso (desta forma gasta metade
parágrafos e faz um uso menos eciente da mancha
do papel e poupa árvores) e uma encadernação sim-
de texto disponível. Com as facilidades oferecidas
ples, com capa plástica transparente colada ou de
pelo processamento de texto em computador, é
argolas e contracapa de cartolina.
igualmente fácil justicar a ambas as margens.
3.2 Estilos de letra
Para dar um aspecto prossional ao relatório, tenha a atenção de formatar para impressão frente-e-
Times NewBookman para o corpo
serifas como Helvetica, Arial
Use um estilo de letra com serifas como
Roman, Nimbus Roman
do texto. Estilos sem
ou
Vera Sans
verso: as margens e cabeçalhos das páginas pares e
ou
ímpares devem ser simétricas para que quem ca-
AT X basta usar
sadas como num livro. Se usar o L
E
a opção de estilo twoside. Num processador de
têm um aspecto mais moderno, mas
são de mais difícil leitura em grandes manchas de
Open Oce Writer,
Format /Page Style /Mirrored.
texto visual como o
texto e devem ser reservados para cabeçalhos cur-
opção
tos, posters, publicidade, etc.
Além do estilo para o corpo, deverá usar um itá-
escolha a
Referências
lico para fazer ênfase a frases ou palavras e um negrito para cabeçalhos de secções. Se quiser trans-
[1]
crever fragmentos do código-fonte de programas ou
The Elements of Style,
entrada e saída de computador, use um estilo de
1918. Ithaca, New-York.
letra mono-espaçado como o
Edição
Courier.
Web
William Strunk, Jr.,
pela Columbia University, URL:
http://sut1.sut.ac.th/strunk.
Evite usar demasiados estilos de letra, pois torna
o documento sobrecarregado de artifícios visuais.
[2]
Quatro estilos básicos como na Tabela 1 em três ou
The Not So Short Introduction to LATEX,
quatro tamanhos deverão ser sucientes.
3.3 Cores
O uso de cor é opcional, mas em qualquer caso deve
ser limitado a grácos e guras (por exemplo: ima-
4
To-
http://www.ctan.org/tex-archive/info/lshort.
bias Oetiker. URL: