Roteiro para escrita de textos - Departamento de Informá · PDF fileque é um...

7

Click here to load reader

Transcript of Roteiro para escrita de textos - Departamento de Informá · PDF fileque é um...

Page 1: Roteiro para escrita de textos - Departamento de Informá · PDF fileque é um resumo, ou seja há ... A seção 3.1 descreve como dividir um capítulo em seções, ... procura fazer

Roteiro para escrita de textosou “Como escrever um TG ou Monografia”

Bruno Müller Junior

7 de Setembro de 2009

Resumo

O presente texto é o resultado da análise e orientação de várias monografias etrabalhos de conclusão de curso. Este texto foi explicado verbalmente para cadaaluno, mas acabei perdendo a paciência de fazer isso verbalmente e resolvi escrevereste texto para orientar os alunos. É um texto queEU adoto em monografias, e nãotenho a esperança que outros usem. Se servir para outras pesosas,ótimo. Se nãoservir, paciência.

1 Introdução

Desde 1993 oriento monografias de conclusão de curso (graduação, especialização, pósgraduação). A maior parte dos alunos sabe escrever um texto pequeno (uma página ouduas), porém se perde completamente quando o texto a ser escrito é maior.

Uma monografia é normalmente composta de mais de 30 páginas, ea minha expe-riência mostrou que os alunos tem uma dificuldade enorme de escrever esta quantidadede páginas de maneira organizada. Normalmente, o texto resultante da primeira ten-tativa é horroroso, onde o leitor deve descobrir o tema, porque o tema foi escolhido,como o tema foi desenvolvido e baseado no que.

Para uniformizar o texto, o termo “aluno” será usado para descrever a pessoa inte-ressada em redigir uma monografia (mesmo que não seja um aluno).

Parto do princípio que o aluno já tem um assunto sobre o que escrever. É importantedeixar claro que este textoNÃO se propõe a ajudar ninguém a escolher um tema.

Assim, uma vez que o tema já é dominado pelo aluno, os passos aqui descrito sãoum roteiro para organizar o tema em capítulos, seções e como usar bibliografia, figuras,tabelas, etc. dentro do texto.

Para atingir o objetivo proposto acima, o texto está dividido da seguinte forma: aseção 2 explica como dividir o texto em capítulos (quais e quantos). A seção 3 descrevecomo organizar cada capítulo. A seção 4 descreve como trabalhar com referênciasbibliográfias e a seção 5 descreve como trabalhar com figuras etabelas.

1

Page 2: Roteiro para escrita de textos - Departamento de Informá · PDF fileque é um resumo, ou seja há ... A seção 3.1 descreve como dividir um capítulo em seções, ... procura fazer

2 A divisão em capítulos

Via de regra, qualquer monografia pode ser dividida em cinco capítulos:

• Capítulo 1 - Introdução Duas a três páginas. Após ler este capítulo, o leitor devesaber do que se trata o texto, e como o aluno se propõe a abordaro tema. Alinguagem deve ser a mais simples possível, de preferência em linguagem deleigo - sem uso de termos técnicos ou de siglas que o leitor pode não conhecer.

• Capítulo 2 - Revisão Bibliográfica Aqui o aluno irá apresentaro “jargão” utili-zado ao longo do texto. Termos comoTCP, entre outros, são explicados aqui.É o capítulo que tem mais referências bibliográficas. Aqui também é incluído ohistórico daquilo que ocorreu com o tema. Por exemplo, quando o tema é “in-ternet”, é esperado que tenha uma explicação de onde surgiu,porque, e quais osmelhoramentos que foram criados ao longo dos anos. Não é necessário entrarem detalhes. A idéia geral já é o suficiente.

• Capítulo 3 - Descrição Conceitual do Trabalho Quando alguém se propõe a es-crever um texto, já tem a idéia do tema que será convertido em texto na cabeça(se não tiver, algo está errado, e quse nada de bom aparecerá no texto). Partindodeste ponto de vista, o tema pode ser descrito “conceitualmente” ou “em deta-lhes”. Se o tema inclui implementação, por exemplo, este capítulo descreve aidéia geral da implementação e o próximo capítulo descreve aimplementação,avaliação e testes efetuados.

• Capítulo 4 - Detalhes do Trabalho Aqui vão os detalhes de implementação, ostestes efetuados e os resultados obtidos no trabalho. Porém, se o trabalho não forimplementado, aqui vão somente detalhes do levantamento. Aidéia é detalhar oque foi estudado e testado. Como a maioria dos resultados obtidos fazem partedeste capítulo, é natural haver uma seção (normalmente a quefecha o capítulo)“Resultados Obtidos”. Assim, é comum que esta seção de resultados contenhaalgo comoA seção 4.x.y apresentou os resultados A e B. Na seção 4.z.w, osre-sultados para o mesmo experimento apresentou os resulados C, D. Esta diferençase deu porque ....

• Capítulo 5 - Conclusão Três a quatro páginas. Para muitos, a conclusão deveser escrita como a introdução, porém no tempo passado. Se na introdução estáescritoEste texto irá descrever ... , conclusão terá algo comoEste texto descre-veu ... . Também há uma análise de resultados obtidos, mas como a parte “porextenso” já foi feita na última seção do capítulo 4, aqui temos um resumo quecomplementa a proposta da introdução. Basta dizer algo comoConforme des-crito na seção 4.k, a aplicação da solução proposta neste trabalho ... . Observeque escreve-se pouco na conclusão (três a quatro páginas no máximo), uma vezque é um resumo, ou seja há necessidade de sintetizar, e não dedetalhar.

O aluno deve sempre ter em mente que o texto que está sendo escrito será lido poralguém, que normalmente tem muitas coisas para fazer além deler seu texto. Se estealguém tiver muita dificuldade de entender o texto (ou seja, usar muuuuito tempo para

2

Page 3: Roteiro para escrita de textos - Departamento de Informá · PDF fileque é um resumo, ou seja há ... A seção 3.1 descreve como dividir um capítulo em seções, ... procura fazer

tentar entender o texto), mesmo havendo um bom conteúdo, a avaliação geral do textoprovavelmente não será boa. É a mesma coisa que ver uma linda fotografia refletidaem uma superfície barrenta. A imagem que fica é duvidosa. A dúvida clássica do leitoré se foi escrita assim de propósito para esconder alguma coisa ou o aluno não sabeescrever. Normalmente a avaliação deste tipo de trabalho varia de bom a péssimo (bomquando existe ainda uma defesa, onde o aluno foi muito bem).

Por outro lado, para um conteúdo ruim, mas um texto bem escrito, a imagem é deuma fotografia feia refletido em um espelho. Vai ser avaliada exatamente como mereceser avaliada.

Aqui entra o orientador. Se ele disse que o tema vale para a monografia, então oaluno deve acreditar nele e fazer o melhor possível para deixar o texto claro. Nestecaso, se houverem problemas, a responsabilidade é do orientador.

3 A organização de cada capítulo

Após determinar em que capítulos escrever, o próximo passo éescrever cada capítulo.A experiência me mostrou que os alunos passam pelos seguintes passos:

1. escrever tudo o que vem à cabeça. Normalmente o texto não tem nenhumaseqüência lógica, e fica parecido com um fios jogados no chão.

2. Após o fracasso da primeira tentativa, muitos chegam à conclusão que simples-mente não está bom e procuram orientação. Alguns poucos acham que mesmoassim está bom e tentam convencer o orientador que está bom assim. Aqui éimportante lembrar: enquanto o orientador achar que não está bom, então nãoadianta discutir. Ou muda de orientador (e ouve a mesma coisado outro orienta-dor) ou melhora o texto de acordo com as orientações.

3. Depois de seguir as orientações, o aluno começa a entendero porquê das coisas.Esta seção tenta passar as dicas de como escrever cada capítulo, e evita o desgastedo orientador (afinal, é para isso que escrevi este texto!).

Esta seção está dividida em seções. A seção 3.1 descreve comodividir um capítuloem seções, e como e quando dividir uma seção em subseções.

Aliás, o parágrafo anterior é um exemplo de quando e como dividir uma seção emsubseções (ou parágrafos em seções). Ao observar que o objetivo da seção pode serdividido em duas subseções, o parágrafo indica ao leitor queo texto serão dividido emseções e em seguida indica em quais seções (indicando o número da seção).

3.1 Como dividir um capítulo em seções

A forma de se organizar um texto científico é muito diferente da forma de organizaroutros tipos de texto, em especial romances. Enquanto em um romance é comum criarsuspense, tantar induzir o leitor para certo raciocínio, emum texto científico a idéia énunca supreender o leitor, e nunca tentar induzí-lo.

Para isso, é sempre necessário que o texto indique com clareza o que está sendoabordado. Muitas vezes o que se deseja explicar ocupa muitaspáginas, e neste caso

3

Page 4: Roteiro para escrita de textos - Departamento de Informá · PDF fileque é um resumo, ou seja há ... A seção 3.1 descreve como dividir um capítulo em seções, ... procura fazer

pode ser uma boa idéia dividir o capítulo em seções ou uma seção em subseções.Quando isso ocorre, éobrigatório que o texto indique quais são as subseções nas quaisirá ser dividido (como foi feito no parágrafo anterior).

Associar a seção com a referência à seção é bastante simples em programas deeditoração como o LaTex, porém é bem mais complicado em programas do tipo Word,OpenOffice e outros.

Aliás, um texto científico tem muitas referências a outros pontos do texto. Porisso, é importante dominar o mecanismo que o programa de editoração fornece parareferenciar outros pontos do texto (seções, figuras, tabelas, bibliografia, etc.). Se oprograma não faz isso automaticamente, é uma boa idéia mudarpara outro que faça.

3.2 Parágrafos e frases

Todos os alunos sabem escrever uma redação. Porém, uma redação normalmente éum texto de até duas páginas, e não pode ser comparado com escrever um texto de 30páginas ou mais.

Quando há muita informação para transmitir, até as coisas mais simples parecemcomplicadas. Um parágrafo é composto de frases (mais de uma frase) que resumemuma idéia, ou linha de pensamento. Quando muda a linha de pensamento, ou aborda-seoutra faceta de uma mesma linha de pensamento, muda-se de parágrafo.

Quando uma pessoa lê um texto, ela pretende entender este texto da forma maisrápida possível. Afinal, um texto científico é escrito para ser lido por pessoas em horade trabalho, e que querem entender o conteúdo o mais rapidamente possível.

Para que o leitor consiga isso, é importante que as frases nãosejam longas - ondetrês linhas cheias já pode ser longo e quatro linhas são insuportavelmente longas. As-sim, é comum escrever frases entre uma linha e meia a duas linhas. Em raros casos,até frases com quatro ou cinco linhas são válidos, mas normalmente deve-se fugir delinhas tão longas.

Aliás, pessoas que militam na área de letras normalmente consideram um erro es-crever frases pequenas, mas acho que se referem a frases de meia linhas ou de umalinha. Aí é complicado mesmo.

Para exemplificar o que estou falando verifique como eu escrevi cada frase e cadaparágrafo desta seção (ou ainda de todo texto). Observe que cada frase contém umaidéia, e que a frase seguinte procura “pegar o gancho” da frase anterior (por vezes re-petindo pedaços da frase ou da idéia contida na frase) para continuar. Por fim, verifiqueem que situações foram colocados novos parágrafos.

As primeiras tentativas de escrever desta forma são cansativas. Depois de algumtempo, passam a ser normais e fica até difícil de não escrever assim.

4 O uso de bibliografia

Não conheci nenhum aluno que sabe usar corretamente os referências bibliográficas(ou bibliografia). Normalmente, o aluno lê muito material para discorrer no texto, eprocura fazer um resumo de tudo o que leu. A idéia correta passa por isso, mas não ésó isso.

4

Page 5: Roteiro para escrita de textos - Departamento de Informá · PDF fileque é um resumo, ou seja há ... A seção 3.1 descreve como dividir um capítulo em seções, ... procura fazer

O texto é um resumo daquilo que leu. Este é o “esqueleto” do texto. Porém écomum precisar incluir idéias que não são próprias, mas com as quais o aluno concorda.

Como este tema pode ser nebuloso, optei por dividir em tópicos que devem serobservados.

• Não se escreve uma referência com “... segundo [1], a seguinte afirmação éverdadeira ... ”. Escreve-se “... afirmação [1] ...”. Ambas indicam a mesmacoisa. Enquanto a primeira alternativa dá uma idéia mais insegura, a segundadiz que a afirmação é do autor indicado (dá os créditos a quem merece), e diz oaluno concorda com ela. É também importante destacar que a fonte pode não serconfiável. Exemplos são revistas de circulação de bairro, sem cunho editorial,ou ainda sem uso de metodologia científica para gerar dados.

• Quando se escreve uma afirmação “forte”, é imprescindível usar a bibliografia.Por exemplo, “ ... o sistema operacional XYZ é fraco no item segurança [1]”.Quando a afirmação é deduzida pelo aluno, então isto deve ser deixado claro -aliás, esse é todo o objetivo da ciência, deduzir coisas novas a partir de dados jádeduzidos e publicados.

• As referências bibliográficas vãotodas no mesmo lugar: a bibliografia (veja nofinal deste texto). O texto em si contém somente índices àquelas referências. Aformatação tanto dos índices quanto das referências bibligráficas pode mudar,maseu gosto que seja como indicado neste texto (ou seja, o índice éum númeroentre colchetes e a referência contém autor, livro, editorae ano). Uma outra fontepara formatação de referências bibliográficas é [6]. Vale a pena consultar. Aliás,aproveite e veja logo toda a série “Normas para apresentaçãode documentoscientíficos”[3, 4, 5, 6, 7, 8, 9, 10, 11].

• Hoje é cada vez mais comum ver informação na internet que valea pensa serusada como referência bibliográfica. A diferença entre uma referência “em pa-pel” para uma referência “em internet” é que a primeira não pode ser apagada danoite para o dia, enquanto que a segunda pode, ou pode ainda mudar de ende-reço. Por isso, quando usar referências da internet é importante destacar o nomedo artigo, o endereço e a data de acesso.

5 Figuras e tabelas

Quase todos os textos científicos tem figuras e tabelas. O problema é que a maioriados alunos acha que uma figura fala por ela mesma, e não coloca nenhum texto paraexplicar aquilo que é o mais importante na figura (ou tabela).

Vamos começar com figuras. Ao incluir uma figura, é necessárioque ela tenha umnúmero (por exemplo, figuraX.y - ondeX é o número do capítulo ey é um númeroseqüencial. E abaixo dela, um texto curto - nunca maior do queuma linha.

O texto deve conter uma referência a esta figura e algumas explicação sobre a figura.A figura não fala por si. É necessário descrever a figura, em especial como a figura serelaciona com o objetivo do tema a ser explicado.

5

Page 6: Roteiro para escrita de textos - Departamento de Informá · PDF fileque é um resumo, ou seja há ... A seção 3.1 descreve como dividir um capítulo em seções, ... procura fazer

Na maioria das vezes um parágrafo é necessário para explicaruma figura. O alunodeve aproveitar a oportunidade de ter um parágrafo inteiro para explicar a figura paradestacar aquilo que é mais importante.

Como exemplo, considere o seguinte trecho extraído de um texto:A figura 1 mostra que parte do programa em execução será abor-dado. Como pode ser visto, a área de código começa no endereçovirtual 0x08048000. Como os diagramas deste texto consideramque endereço 0x00000000 está “em baixo” e o endereço 0xFFFFFFFFestá em cima, o programa em execução tem seu menor endereço em0x08048000, e as instruções são copiadas do arquivo para este ende-reço “para cima”. Assim que a última instrução é copiada, começa aárea de dados.

Figura 1: Programa em execução na memória virtual - área de texto e dados globais(formato ELF)

Agora, vamos abordar tabelas. Na verdade, não há muito mais aacrescentar. Ta-belas devem ser tratadas como figuras, e deve haver um texto que explica a tabela.Quando uma tabela é copiada de um outro texto, é necessário indicar de onde (re-ferência bibliográfica), e deve haver um texto explicando aquilo que for consideradoimportante.

Porém, quando uma tabela é incluída para comparar coisas queforam examinadasno texto (por exemplo, o desempenho comparativo de duas soluções para o mesmoproblema), é imprescindível que o aluno descreva aqueles pontos mais relevantes. Porexemplo, ao comparar o desempenho de um algoritmo em uma máquina com um nú-cleo com o desempenho do mesmo algoritmo em uma máquina deN núcleos, e inte-ressante destacar se o desempenho na máquina deN núcleos é1

N , e se não for, explicarporque. Quando este tipo de tabela é incluído, é muito comum que o texto explicativoocupe vários parágrafos.

6

Page 7: Roteiro para escrita de textos - Departamento de Informá · PDF fileque é um resumo, ou seja há ... A seção 3.1 descreve como dividir um capítulo em seções, ... procura fazer

Referências

[1] Autor1, Nome do livro1, Editora, Ano

[2] Autor2, Nome do livro1, Editora, Ano

[3] Normas para apresentação de documentos científicos: 1 - Projetos, Editora UFPR.

[4] Normas para apresentação de documentos científicos: 2 - Teses, dissertações,monografias e outros trabalhos acadêmicos, Editora UFPR.

[5] Normas para apresentação de documentos científicos: 3 - Citações e notas derodapé, Editora UFPR.

[6] Normas para apresentação de documentos científicos: 4 - Referências, EditoraUFPR.

[7] Normas para apresentação de documentos científicos: 5 - Relatórios, EditoraUFPR.

[8] Normas para apresentação de documentos científicos: 6 - Periódicos e artigos deperiódicos, Editora UFPR.

[9] Normas para apresentação de documentos científicos: 7 - Livros e folhetos, Edi-tora UFPR.

[10] Normas para apresentação de documentos científicos: 8 -Curriculum vitae e me-morial, Editora UFPR.

[11] Normas para apresentação de documentos científicos: 9 -Redação e editoração,Editora UFPR.

7