Como redigir um relatrio de estgio

Pedro Vasconcelos pbv@dcc.fc.up.pt Departamento de Cincia de Computadores Faculdade de Cincias da Universidade do Porto 2 de Maro de 2009

1 Introduo
Este texto pretende servir de guia na elaborao do relatrio de estgio para alunos das licenciaturas em Cincia de Computadores e Engenharia de Redes e Sistemas Informticos. simultaneamente O objectivo ser dar su-

docentes. Tambm poder interessar aos orientadores e possivelmente a outros alunos de licenciatura que, por exemplo, pretendam fazer um estgio na mesma instituio. Todos estes potenciais leitores partilham uma base de formao cientco-tecnolgica, embora no necessariamente com a mesma profundidade ou na mesma rea. Assim, ao redigir o relatrio deve evitar explicaes detalhadas de conceitos elementares (e.g. a importncia das bases de dados) e concentrese na especicidade do seu trabalho (e.g. recolha de informaes de uma base de dados relacional para produzir relatrios clnicos). Inclua uma referncia bibliogra de base para ajudar os leitores sem formao na rea. Isto tem duas vantagens: torna o texto mais sucinto e evita aborrecer os potenciais leitores.

pedaggico

prolctico :

gestes prticas bencas e chamar a ateno para potenciais problemas.

1.1 O que um relatrio?

Um relatrio um documento que descreve em detalhe um trabalho tcnico, como uma experincia cientca ou a implementao de uma tecnologia. No contexto da disciplina de Estgio, o relatrio escrito pelo aluno no nal do semestre como uma sntese do trabalho efectuado na instituio de acolhimento. Um relatrio

ou biogrca :

no uma obra artstica, literria

o texto deve ser conciso, claro e di-

2 Conselhos de redaco
2.1 Estrutura global
Deve seguir uma estrutura hierrquica em seces e sub-seces. Use apenas dois ou trs nveis de Mais nveis impem numerao de seces: seces, sub-seces e (possivelmente) sub-sub-seces. para um relatrio. Planeie as seces que vai usar antecipadamente, escrevendo os cabealhos primeiro e preenchendo o texto depois. A estrutura tpica poder ser: uma sobrecarga burocrtica que no se justica

recto, com o mnimo de elementos supruos, quer de contedo quer de estilo. Tambm

no deve ser a coleco de toda a informao recolhida ou a listagem completa dos programas desenvolvidos. Se de excertos representativos das solues que usou. Tambm

achar oportuno incluir listagens, faa uma seleco

no um manual de utilizao :

embora

possa descrever a utilizao de um ou mais programas implementados, coloque a nfase nas tecnologias e mtodos que usou.

1.2 Quem l o relatrio?

O relatrio de Estgio serve como um dos elementos de avaliao da disciplina e como tal ser lido pelos

Capa:

Ttulo/Autor/Data; (01 pg.);

Agradecimentos:
1

Seco 1: Seco 2: Seco 3: Seco 4: Seco 5:

(25 pg.)

Introduo/descrio do

2.2 Frases e pargrafos

As duas unidades fundamentais de texto so a e o

problema;

(210 pg.)

Descrio do estado-da-

pargrafo.

frase

Um pargrafo uma sequncia de

arte/tecnologias a usar;

frases em que o uxo de discurso est encadeado. Deve-se comear um novo pargrafo apenas quando se interrompe este uxo. Quando se escreve um documento num processador de texto necessrio ter em conta como e quando se introduzem as quebras de pargrafo. No deve introduzir pargrafos s porque quer uma mudana de linha: o pargrafo uma unidade de estrutura do texto, no um elemento de formatao visual. Se usar um processador de texto WYSIWYG , como o

(520 pg.) Implementao;

(520 pg.) Exemplos/Resultados;

(25 pg.) Concluses;

Apndices:

(120 pg.) Bibliograa, excertos de

listagems. Apenas a introduo e concluso so obrigatrias; as outras seces podero ser modicadas conforme o caso. Tenha como objectivo um relatrio com 40 pginas mais os apndices, num mximo de 80100 pginas no total. Reserve os agradecimentos para pessoas e instituies que contribuiram directamente para o seu trabalho, e.g. algum que o ajudou a instalar um programa ou lhe facultou bibliograa. Os agradecimentos no so uma dedicatria: no faz sentido agradecer aos seus pais por o terem colocado no mundo. . . .

Microsoft Word ou Open Oce Writer, pode usar a opo View Nonprinting characters para visualizar os espaos com `' e as quebras de pargrafo com `'. No escreva frases demasiado longas; um pargrafo no deve ser uma nica frase sem quebras. Use os sinais de pontuao (`,' `;' `:' `.') para separar frases. A vrgula marca uma pausa ligeira na leitura, o ponto-e-vrgula marca uma pausa maior e o ponto-nal marca o m duma frase. Uma regra simples (mas no infalvel) para decidir onde se deve introduzir uma vrgula ler a frase em voz alta: se necessitar de fazer uma pausa num determinado ponto, deve introduzir a vrgula; seno, pode omiti-la.

tivos

A introduo deve descrever claramente os

objec-

do seu trabalho de estgio (e.g. extender uma

base de dados hospitalar para produzir relatrios clnicos). Deve tambm aproveitar para enquadrar esse trabalho no contexto da instituio de acolhimento (e.g. como surgiu a necessidade da base de dados, que entidades a utilizam, porque til produzir os relatrios). A descrio de tecnologias e implementao deve focar os

2.3 Discurso e tempo verbal

Como o trabalho de estgio individual, tanto pode escrever na primeira pessoa do singular como na primeira pessoa do plural (usando o plural majesttico):

mtodos e ferramentas

que usou para atin-

1a pessoa do singular: 1a pessoa do plural:

Neste trabalho [

eu ]

im-

plementei uma base de dados relacional. . .  Neste trabalho [

gir os objectivos propostos: linguagens de programao, bibliotecas, gestores de base de dados, etc. Se o trabalho envolver comparao de tecnologias alternativas, deve descrev-las nesta seco. As escolhas de tecnologia so muitas vezes ditadas pelo orientador ou pela necessidade de integrao em sistemas existentes; descreva essas opes como um ponto de partida para o seu trabalho, mas no as tente racionalizar com argumentos falaciosos (e.g. no escreva usamos a linguagem X porque suporta modularidade, uma vez que haveria muitas outras alternativas igualmente modulares).

ns ]

im-

plementamos uma base de dados relacional. . .  O que no deve fazer variar entre o singular e o plural no mesmo documento. A excepo a esta regra usar o singular para trabalho indidivual e o plural para o trabalho do grupo em que se insere. Tenha o cuidado de usar um tempo verbal consistente. Como o relatrio descreve trabalho passado, o mais natural ser usar o pretrio perfeito:

1 Acrnimo

para

What You See Is What You Get

Pretrito perfeito:
sitei

Neste trabalho

uma base de dados relacional. Para tal, das seguintes tecnologias. . .  Neste trabalho

implementei neces-

2.8 Tradues
Muitos termos tcnicos em ingls no tm (ainda?) traduo estabilizada em portugus. Em vez de tentar improvisar uma traduo, ser prefervel deixar os termos na lngua de origem tipografados em itlico ou entre aspas:

Presente:

de dados relacional.

Para tal,

implemento uma base necessito das

seguintes tecnologias. . . 

rewall, pipeline, etc.

software, thread, kernel,

2.4 Voz activa e passiva

Um dos erros de escrita mais comums o abuso da voz passiva. Compare estas duas frases:

2.9 Concluses
As concluses do relatrio devem descrever de que forma os objectivos originais foram (ou no) atingidos. Alguns conselhos sobre como as redigir:

Voz passiva: Voz activa:

As grandes diculdades encontra-

das foram sobretudo duas. Encontramos sobretudo duas gran-

melhor ser factual do que fazer julgamentos de valor: um relatrio deve

relatar

o que fez

des diculdades. A primeira frase coloca a nfase sobre as diculdades, enquanto a segunda coloca a nfase no autor (

e no julgar se o trabalho foi brilhante, mediano ou mau. Diga claramente o que funcionou e que o no funcionou, o que correu bem ou menos bem.

ns

encontramos). A voz activa d mais prota-

gonismo ao autor e ao seu trabalho, e resulta num discurso mais directo e numa frase mais curta.

O relatrio redigido no nal do semestre mas no necessariamente no nal do projecto. Se for caso disso, indique possiveis desenvolvimentos futuros do seu trabalho.

2.5 Referncias indirectas

No abuse de referncias indirectas como o que, as quais, estes ou os mesmos. Tornam o texto difcil de seguir ou mesmo mbiguo. Em nenhum caso comece uma frase com O que. . .  ainda. . . . ou E

No torne as suas concluses demasiado subjectivas: evite os adjectivos e advrbios como imenso, vasto ou grandemente para classicar o seu trabalho. Evite a tudo custo o auto-elogio (surte geralmente o efeito oposto).

Evite um discurso apologtico desculpando-se com a falta de experincia: estranho seria que j tivesse experincia antes do estgio! Em vez disso, realce o que apreendeu e o que teria feito de maneira diferente se comeasse o trabalho de novo.

2.6 Listas e itemizao

Para descrever sequncias de tpicos pode optar por usar listas itemizadas, mas com moderao: cada lista deve ter pelo menos dois items e menos de que dez. No use listas dentro de listas: melhor hieraquizar as denies e listar conceitos subordinados separadamente.

2.10 Bibliograa
Inclua uma lista de bibliograa nos apndices. As entradas devem ser numeradas para fcil referncia no texto. (e.g. [1]). No caso de citar livros ou artigos cientcos deve incluir ttulo, autor, ano e editora Para pginas de

2.7 Figuras e tabelas

Elementos soltos como guras e tabelas deve ser numerados e etiquetados com uma legenda. Pondere bem a incluso de guras no meio do texto: alm de reduzirem o espao, interrompem o uxo de leitura. Inclua apenas as guras que realmente contribuem para o acompanhamento do texto. Figuras ou tabelas extra devem ser colocadas nos apndices.

Web

deve incluir um

ttulo descritivo, autor e o URL (e.g. [2])

2.11 Ortograa
Use sempre um corrector automtico de ortograa antes de entregar o relatrio: mesmo que no seja

Itlico ABCDabcdefghij Negrito ABCDabcdefghij

Mquina ABCDabcdefghij

Romano ABCDabcdefghij

corpo do texto nfase cabealhos programas

gens de janelas duma aplicao).

No use cr no

corpo do texto, cabealhos ou rodap: no s encarece a custo de impresso como pode mesmo dicultar a leitura. Lembre-se que nem todas as pessoas vm todas as cores (daltonismo).

Tabela 1: Sugestes de estilos para texto

3.4 Margens e justicao

Evite a tentao de reduzir as margens para colocar mais palavras por pgina. Cada linha deve ter cerca de 60 a 66 caracteres; mais caracteres por linha tornam a leitura difcil e requerem um maior espaamento entre linhas. Tambm no use mais de 45 linhas de texto por pgina. Com um comprimento mdio de 5 letras por palavra, estes limites do um mximo de 400500 palavras por pgina. Na prtica, a pgina ter muito menos palavras por causa do espao para cabealhos e guras. Recomenda-se a justicao a ambas as margens. Justicar apenas esquerda (como neste paragrfo) torna mais difcil detectar a quebra de pargrafos e faz um uso menos eciente da mancha de texto disponvel. Com as facilidades oferecidas pelo processamento de texto em computador, igualmente fcil justicar a ambas as margens. Para dar um aspecto prossional ao relatrio, tenha a ateno de formatar para impresso frente-everso: as margens e cabealhos das pginas pares e mpares devem ser simtricas para que quem ca-

perfeito, detecta muitos erros simples sem esforo. Pode usar o dicionrio portugus do com o

A L T X e o dicionrio portugus-brasileiro do E

ispell

Open Oce Writer.

myspell

com o

3 Conselhos de tipograa
3.1 Formato e encadernao
O relatrio deve ser formatado em pginas A4, com tamanho de letra 11pt. As pginas, seces e guras devem ser numeradas. Recomenda-se a impresso em papel reciclado branco em frente-e-verso (desta forma gasta metade do papel e poupa rvores) e uma encadernao simples, com capa plstica transparente colada ou de argolas e contracapa de cartolina.

3.2 Estilos de letra

Roman, Nimbus Roman
do texto. Estilos sem ou Use um estilo de letra com serifas como ou

Vera Sans

Times NewBookman para o corpo serifas como Helvetica, Arial

tm um aspecto mais moderno, mas

so de mais difcil leitura em grandes manchas de texto e devem ser reservados para cabealhos curtos, posters, publicidade, etc. Alm do estilo para o corpo, dever usar um itlico para fazer nfase a frases ou palavras e um negrito para cabealhos de seces. Se quiser transcrever fragmentos do cdigo-fonte de programas ou entrada e sada de computador, use um estilo de letra mono-espaado como o

A sadas como num livro. Se usar o L T X basta usar E a opo de estilo twoside. Num processador de
texto visual como o opo

Open Oce Writer, Format /Page Style /Mirrored.

escolha a

Referncias
[1]

The Elements of Style,

1918. Ithaca, New-York. Edio

William Strunk, Jr.,

Courier.

Evite usar demasiados estilos de letra, pois torna o documento sobrecarregado de artifcios visuais. Quatro estilos bsicos como na Tabela 1 em trs ou quatro tamanhos devero ser sucientes. [2]

http://sut1.sut.ac.th/strunk.
bias Oetiker. URL:

Web

pela Columbia University, URL:

A The Not So Short Introduction to L TEX,

http://www.ctan.org/tex-archive/info/lshort.

To-

3.3 Cores
O uso de cor opcional, mas em qualquer caso deve ser limitado a grcos e guras (por exemplo: ima-