Roteiro para escrita de textos

Roteiro para escrita de textos ou 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 e trabalhos de conclusão de curso. Este texto foi explicado verbalmente para cada aluno, mas acabei perdendo a paciência de fazer isso verbalmente e resolvi escrever este texto para orientar os alunos. É um texto que EU adoto em monografias, e não tenho a esperança que outros usem. Se servir para outras pesosas, ótimo. Se não servir, paciência. 1 Introdução Desde 1993 oriento monografias de conclusão de curso (graduação, especialização, pós graduação). A maior parte dos alunos sabe escrever um texto pequeno (uma página ou duas), porém se perde completamente quando o texto a ser escrito é maior. Uma monografia é normalmente composta de mais de 30 páginas, e a minha experiência mostrou que os alunos tem uma dificuldade enorme de escrever esta quantidade de páginas de maneira organizada. Normalmente, o texto resultante da primeira tentativa é 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 interessada 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. É importante deixar claro que este texto NÃ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ão um 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: a seção 2 explica como dividir o texto em capítulos (quais e quantos). A seção 3 descreve como organizar cada capítulo. A seção 4 descreve como trabalhar com referências bibliográfias e a seção 5 descreve como trabalhar com figuras e tabelas. 1

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 deve saber do que se trata o texto, e como o aluno se propõe a abordar o tema. A linguagem deve ser a mais simples possível, de preferência em linguagem de leigo - 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á apresentar o jargão utilizado ao longo do texto. Termos como TCP, entre outros, são explicados aqui. É o capítulo que tem mais referências bibliográficas. Aqui também é incluído o histórico daquilo que ocorreu com o tema. Por exemplo, quando o tema é internet, é esperado que tenha uma explicação de onde surgiu, porque, e quais os melhoramentos que foram criados ao longo dos anos. Não é necessário entrar em detalhes. A idéia geral já é o suficiente. Capítulo 3 - Descrição Conceitual do Trabalho Quando alguém se propõe a escrever 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). Partindo deste ponto de vista, o tema pode ser descrito conceitualmente ou em detalhes. Se o tema inclui implementação, por exemplo, este capítulo descreve a idéia geral da implementação e o próximo capítulo descreve a implementação, avaliação e testes efetuados. Capítulo 4 - Detalhes do Trabalho Aqui vão os detalhes de implementação, os testes efetuados e os resultados obtidos no trabalho. Porém, se o trabalho não for implementado, aqui vão somente detalhes do levantamento. A idéia é detalhar o que foi estudado e testado. Como a maioria dos resultados obtidos fazem parte deste capítulo, é natural haver uma seção (normalmente a que fecha o capítulo) Resultados Obtidos. Assim, é comum que esta seção de resultados contenha algo como A seção 4.x.y apresentou os resultados A e B. Na seção 4.z.w, os resultados para o mesmo experimento apresentou os resulados C, D. Esta diferença se deu porque... Capítulo 5 - Conclusão Três a quatro páginas. Para muitos, a conclusão deve ser escrita como a introdução, porém no tempo passado. Se na introdução está escrito Este texto irá descrever..., conclusão terá algo como Este texto descreveu.... Também há uma análise de resultados obtidos, mas como a parte por extenso já foi feita na última seção do capítulo 4, aqui temos um resumo que complementa a proposta da introdução. Basta dizer algo como Conforme descrito na seção 4.k, a aplicação da solução proposta neste trabalho.... Observe que escreve-se pouco na conclusão (três a quatro páginas no máximo), uma vez que é um resumo, ou seja há necessidade de sintetizar, e não de detalhar. O aluno deve sempre ter em mente que o texto que está sendo escrito será lido por alguém, que normalmente tem muitas coisas para fazer além de ler seu texto. Se este alguém tiver muita dificuldade de entender o texto (ou seja, usar muuuuito tempo para 2

tentar entender o texto), mesmo havendo um bom conteúdo, a avaliação geral do texto provavelmente não será boa. É a mesma coisa que ver uma linda fotografia refletida em 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 sabe escrever. Normalmente a avaliação deste tipo de trabalho varia de bom a péssimo (bom quando 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 é de uma fotografia feia refletido em um espelho. Vai ser avaliada exatamente como merece ser avaliada. Aqui entra o orientador. Se ele disse que o tema vale para a monografia, então o aluno deve acreditar nele e fazer o melhor possível para deixar o texto claro. Neste caso, 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 nenhuma seqüê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 simplesmente não está bom e procuram orientação. Alguns poucos acham que mesmo assim 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ão adianta discutir. Ou muda de orientador (e ouve a mesma coisa do outro orientador) ou melhora o texto de acordo com as orientações. 3. Depois de seguir as orientações, o aluno começa a entender o porquê das coisas. Esta seção tenta passar as dicas de como escrever cada capítulo, e evita o desgaste do orientador (afinal, é para isso que escrevi este texto!). Esta seção está dividida em seções. A seção 3.1 descreve como dividir um capítulo em 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 em subseções (ou parágrafos em seções). Ao observar que o objetivo da seção pode ser dividido em duas subseções, o parágrafo indica ao leitor que o texto serão dividido em seçõ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 organizar outros tipos de texto, em especial romances. Enquanto em um romance é comum criar suspense, tantar induzir o leitor para certo raciocínio, em um 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á sendo abordado. Muitas vezes o que se deseja explicar ocupa muitas páginas, e neste caso 3

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 quais irá ser dividido (como foi feito no parágrafo anterior). Associar a seção com a referência à seção é bastante simples em programas de editoraçã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. Por isso, é importante dominar o mecanismo que o programa de editoração fornece para referenciar outros pontos do texto (seções, figuras, tabelas, bibliografia, etc.). Se o programa não faz isso automaticamente, é uma boa idéia mudar para 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 30 páginas ou mais. Quando há muita informação para transmitir, até as coisas mais simples parecem complicadas. Um parágrafo é composto de frases (mais de uma frase) que resumem uma idéia, ou linha de pensamento. Quando muda a linha de pensamento, ou aborda-se outra 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 mais rápida possível. Afinal, um texto científico é escrito para ser lido por pessoas em hora de trabalho, e que querem entender o conteúdo o mais rapidamente possível. Para que o leitor consiga isso, é importante que as frases não sejam longas - onde três linhas cheias já pode ser longo e quatro linhas são insuportavelmente longas. Assim, é 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 de linhas tão longas. Aliás, pessoas que militam na área de letras normalmente consideram um erro escrever frases pequenas, mas acho que se referem a frases de meia linhas ou de uma linha. Aí é complicado mesmo. Para exemplificar o que estou falando verifique como eu escrevi cada frase e cada parágrafo desta seção (ou ainda de todo texto). Observe que cada frase contém uma idéia, e que a frase seguinte procura pegar o gancho da frase anterior (por vezes repetindo pedaços da frase ou da idéia contida na frase) para continuar. Por fim, verifique em que situações foram colocados novos parágrafos. As primeiras tentativas de escrever desta forma são cansativas. Depois de algum tempo, 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, e procura fazer um resumo de tudo o que leu. A idéia correta passa por isso, mas não é só isso. 4

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 ser observados. Não se escreve uma referência com... segundo [1], a seguinte afirmação é verdadeira.... Escreve-se... afirmação [1].... Ambas indicam a mesma coisa. Enquanto a primeira alternativa dá uma idéia mais insegura, a segunda diz que a afirmação é do autor indicado (dá os créditos a quem merece), e diz o aluno concorda com ela. É também importante destacar que a fonte pode não ser confiá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ão todas no mesmo lugar: a bibliografia (veja no final deste texto). O texto em si contém somente índices àquelas referências. A formatação tanto dos índices quanto das referências bibligráficas pode mudar, mas eu gosto que seja como indicado neste texto (ou seja, o índice é um número entre colchetes e a referência contém autor, livro, editora e ano). Uma outra fonte para 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ção de documentos científicos [3, 4, 5, 6, 7, 8, 9, 10, 11]. Hoje é cada vez mais comum ver informação na internet que vale a pensa ser usada como referência bibliográfica. A diferença entre uma referência em papel para uma referência em internet é que a primeira não pode ser apagada da noite para o dia, enquanto que a segunda pode, ou pode ainda mudar de endereço. Por isso, quando usar referências da internet é importante destacar o nome do 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 maioria dos alunos acha que uma figura fala por ela mesma, e não coloca nenhum texto para explicar aquilo que é o mais importante na figura (ou tabela). Vamos começar com figuras. Ao incluir uma figura, é necessário que ela tenha um número (por exemplo, figura X.y - onde X é o número do capítulo e y é um número seqüencial. E abaixo dela, um texto curto - nunca maior do que uma 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 se relaciona com o objetivo do tema a ser explicado. 5

Na maioria das vezes um parágrafo é necessário para explicar uma figura. O aluno deve aproveitar a oportunidade de ter um parágrafo inteiro para explicar a figura para destacar 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á abordado. Como pode ser visto, a área de código começa no endereço virtual 0x08048000. Como os diagramas deste texto consideram que endereço 0x00000000 está em baixo e o endereço 0xFFFFFFFF está em cima, o programa em execução tem seu menor endereço em 0x08048000, e as instruções são copiadas do arquivo para este endereç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 a acrescentar. Tabelas 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 (referência bibliográfica), e deve haver um texto explicando aquilo que for considerado importante. Porém, quando uma tabela é incluída para comparar coisas que foram examinadas no texto (por exemplo, o desempenho comparativo de duas soluções para o mesmo problema), é imprescindível que o aluno descreva aqueles pontos mais relevantes. Por exemplo, 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 de N núcleos, e interessante destacar se o desempenho na máquina de N núcleos é N 1, e se não for, explicar porque. Quando este tipo de tabela é incluído, é muito comum que o texto explicativo ocupe vários parágrafos. 6

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 de rodapé, Editora UFPR. [6] Normas para apresentação de documentos científicos: 4 - Referências, Editora UFPR. [7] Normas para apresentação de documentos científicos: 5 - Relatórios, Editora UFPR. [8] Normas para apresentação de documentos científicos: 6 - Periódicos e artigos de periódicos, Editora UFPR. [9] Normas para apresentação de documentos científicos: 7 - Livros e folhetos, Editora UFPR. [10] Normas para apresentação de documentos científicos: 8 - Curriculum vitae e memorial, Editora UFPR. [11] Normas para apresentação de documentos científicos: 9 - Redação e editoração, Editora UFPR. 7