Roteiro para escrita de textos

o u Como escrever um TG ou Monograa

Bruno Mller Junior 7 de Setembro de 2009

Resumo O presente texto o resultado da anlise e orientao de vrias monograas e trabalhos de concluso de curso. Este texto foi explicado verbalmente para cada aluno, mas acabei perdendo a pacincia de fazer isso verbalmente e resolvi escrever este texto para orientar os alunos. um texto que EU adoto em monograas, e no tenho a esperana que outros usem. Se servir para outras pesosas, timo. Se no servir, pacincia.

1 Introduo
Desde 1993 oriento monograas de concluso de curso (graduao, especializao, ps graduao). A maior parte dos alunos sabe escrever um texto pequeno (uma pgina ou duas), porm se perde completamente quando o texto a ser escrito maior. Uma monograa normalmente composta de mais de 30 pginas, e a minha experincia mostrou que os alunos tem uma diculdade enorme de escrever esta quantidade de pginas 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 monograa (mesmo que no seja um aluno). Parto do princpio que o aluno j tem um assunto sobre o que escrever. importante deixar claro que este texto NO se prope a ajudar ningum a escolher um tema. Assim, uma vez que o tema j dominado pelo aluno, os passos aqui descrito so um roteiro para organizar o tema em captulos, sees e como usar bibliograa, guras, tabelas, etc. dentro do texto. Para atingir o objetivo proposto acima, o texto est dividido da seguinte forma: a seo 2 explica como dividir o texto em captulos (quais e quantos). A seo 3 descreve como organizar cada captulo. A seo 4 descreve como trabalhar com referncias bibliogras e a seo 5 descreve como trabalhar com guras e tabelas.

2 A diviso em captulos
Via de regra, qualquer monograa pode ser dividida em cinco captulos: Captulo 1 - Introduo Duas a trs pginas. Aps ler este captulo, o leitor deve saber do que se trata o texto, e como o aluno se prope a abordar o tema. A linguagem deve ser a mais simples possvel, de preferncia em linguagem de leigo - sem uso de termos tcnicos ou de siglas que o leitor pode no conhecer. Captulo 2 - Reviso Bibliogrca Aqui o aluno ir apresentar o jargo utilizado ao longo do texto. Termos como TCP, entre outros, so explicados aqui. o captulo que tem mais referncias bibliogrcas. Aqui tambm includo o histrico daquilo que ocorreu com o tema. Por exemplo, quando o tema internet, esperado que tenha uma explicao de onde surgiu, porque, e quais os melhoramentos que foram criados ao longo dos anos. No necessrio entrar em detalhes. A idia geral j o suciente. Captulo 3 - Descrio Conceitual do Trabalho Quando algum se prope a escrever um texto, j tem a idia do tema que ser convertido em texto na cabea (se no 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 implementao, por exemplo, este captulo descreve a idia geral da implementao e o prximo captulo descreve a implementao, avaliao e testes efetuados. Captulo 4 - Detalhes do Trabalho Aqui vo os detalhes de implementao, os testes efetuados e os resultados obtidos no trabalho. Porm, se o trabalho no for implementado, aqui vo somente detalhes do levantamento. A idia detalhar o que foi estudado e testado. Como a maioria dos resultados obtidos fazem parte deste captulo, natural haver uma seo (normalmente a que fecha o captulo) Resultados Obtidos. Assim, comum que esta seo de resultados contenha algo como A seo 4.x.y apresentou os resultados A e B. Na seo 4.z.w, os resultados para o mesmo experimento apresentou os resulados C, D. Esta diferena se deu porque .... Captulo 5 - Concluso Trs a quatro pginas. Para muitos, a concluso deve ser escrita como a introduo, porm no tempo passado. Se na introduo est escrito Este texto ir descrever ... , concluso ter algo como Este texto descreveu ... . Tambm h uma anlise de resultados obtidos, mas como a parte por extenso j foi feita na ltima seo do captulo 4, aqui temos um resumo que complementa a proposta da introduo. Basta dizer algo como Conforme descrito na seo 4.k, a aplicao da soluo proposta neste trabalho ... . Observe que escreve-se pouco na concluso (trs a quatro pginas no mximo), uma vez que um resumo, ou seja h necessidade de sintetizar, e no de detalhar. O aluno deve sempre ter em mente que o texto que est sendo escrito ser lido por algum, que normalmente tem muitas coisas para fazer alm de ler seu texto. Se este algum tiver muita diculdade de entender o texto (ou seja, usar muuuuito tempo para 2

tentar entender o texto), mesmo havendo um bom contedo, a avaliao geral do texto provavelmente no ser boa. a mesma coisa que ver uma linda fotograa reetida em uma superfcie barrenta. A imagem que ca duvidosa. A dvida clssica do leitor se foi escrita assim de propsito para esconder alguma coisa ou o aluno no sabe escrever. Normalmente a avaliao deste tipo de trabalho varia de bom a pssimo (bom quando existe ainda uma defesa, onde o aluno foi muito bem). Por outro lado, para um contedo ruim, mas um texto bem escrito, a imagem de uma fotograa feia reetido em um espelho. Vai ser avaliada exatamente como merece ser avaliada. Aqui entra o orientador. Se ele disse que o tema vale para a monograa, ento o aluno deve acreditar nele e fazer o melhor possvel para deixar o texto claro. Neste caso, se houverem problemas, a responsabilidade do orientador.

3 A organizao de cada captulo

Aps determinar em que captulos escrever, o prximo passo escrever cada captulo. A experincia me mostrou que os alunos passam pelos seguintes passos: 1. escrever tudo o que vem cabea. Normalmente o texto no tem nenhuma seqncia lgica, e ca parecido com um os jogados no cho. 2. Aps o fracasso da primeira tentativa, muitos chegam concluso que simplesmente no est bom e procuram orientao. 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 no est bom, ento no adianta discutir. Ou muda de orientador (e ouve a mesma coisa do outro orientador) ou melhora o texto de acordo com as orientaes. 3. Depois de seguir as orientaes, o aluno comea a entender o porqu das coisas. Esta seo tenta passar as dicas de como escrever cada captulo, e evita o desgaste do orientador (anal, para isso que escrevi este texto!). Esta seo est dividida em sees. A seo 3.1 descreve como dividir um captulo em sees, e como e quando dividir uma seo em subsees. Alis, o pargrafo anterior um exemplo de quando e como dividir uma seo em subsees (ou pargrafos em sees). Ao observar que o objetivo da seo pode ser dividido em duas subsees, o pargrafo indica ao leitor que o texto sero dividido em sees e em seguida indica em quais sees (indicando o nmero da seo).

3.1

Como dividir um captulo em sees

A forma de se organizar um texto cientco 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 raciocnio, em um texto cientco a idia nunca supreender o leitor, e nunca tentar induz-lo. Para isso, sempre necessrio que o texto indique com clareza o que est sendo abordado. Muitas vezes o que se deseja explicar ocupa muitas pginas, e neste caso 3

pode ser uma boa idia dividir o captulo em sees ou uma seo em subsees. Quando isso ocorre, obrigatrio que o texto indique quais so as subsees nas quais ir ser dividido (como foi feito no pargrafo anterior). Associar a seo com a referncia seo bastante simples em programas de editorao como o LaTex, porm bem mais complicado em programas do tipo Word, OpenOfce e outros. Alis, um texto cientco tem muitas referncias a outros pontos do texto. Por isso, importante dominar o mecanismo que o programa de editorao fornece para referenciar outros pontos do texto (sees, guras, tabelas, bibliograa, etc.). Se o programa no faz isso automaticamente, uma boa idia mudar para outro que faa.

3.2

Pargrafos e frases

Todos os alunos sabem escrever uma redao. Porm, uma redao normalmente um texto de at duas pginas, e no pode ser comparado com escrever um texto de 30 pginas ou mais. Quando h muita informao para transmitir, at as coisas mais simples parecem complicadas. Um pargrafo composto de frases (mais de uma frase) que resumem uma idia, ou linha de pensamento. Quando muda a linha de pensamento, ou aborda-se outra faceta de uma mesma linha de pensamento, muda-se de pargrafo. Quando uma pessoa l um texto, ela pretende entender este texto da forma mais rpida possvel. Anal, um texto cientco escrito para ser lido por pessoas em hora de trabalho, e que querem entender o contedo o mais rapidamente possvel. Para que o leitor consiga isso, importante que as frases no sejam longas - onde trs linhas cheias j pode ser longo e quatro linhas so insuportavelmente longas. Assim, comum escrever frases entre uma linha e meia a duas linhas. Em raros casos, at frases com quatro ou cinco linhas so vlidos, mas normalmente deve-se fugir de linhas to longas. Alis, 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 exemplicar o que estou falando verique como eu escrevi cada frase e cada pargrafo desta seo (ou ainda de todo texto). Observe que cada frase contm uma idia, e que a frase seguinte procura pegar o gancho da frase anterior (por vezes repetindo pedaos da frase ou da idia contida na frase) para continuar. Por m, verique em que situaes foram colocados novos pargrafos. As primeiras tentativas de escrever desta forma so cansativas. Depois de algum tempo, passam a ser normais e ca at difcil de no escrever assim.

4 O uso de bibliograa
No conheci nenhum aluno que sabe usar corretamente os referncias bibliogrcas (ou bibliograa). Normalmente, o aluno l muito material para discorrer no texto, e procura fazer um resumo de tudo o que leu. A idia correta passa por isso, mas no s isso.

O texto um resumo daquilo que leu. Este o esqueleto do texto. Porm comum precisar incluir idias que no so prprias, mas com as quais o aluno concorda. Como este tema pode ser nebuloso, optei por dividir em tpicos que devem ser observados. No se escreve uma referncia com ... segundo [1], a seguinte armao verdadeira ... . Escreve-se ... armao [1] .... Ambas indicam a mesma coisa. Enquanto a primeira alternativa d uma idia mais insegura, a segunda diz que a armao do autor indicado (d os crditos a quem merece), e diz o aluno concorda com ela. tambm importante destacar que a fonte pode no ser convel. Exemplos so revistas de circulao de bairro, sem cunho editorial, ou ainda sem uso de metodologia cientca para gerar dados. Quando se escreve uma armao forte, imprescindvel usar a bibliograa. Por exemplo, ... o sistema operacional XYZ fraco no item segurana [1]. Quando a armao deduzida pelo aluno, ento isto deve ser deixado claro alis, esse todo o objetivo da cincia, deduzir coisas novas a partir de dados j deduzidos e publicados. As referncias bibliogrcas vo todas no mesmo lugar: a bibliograa (veja no nal deste texto). O texto em si contm somente ndices quelas referncias. A formatao tanto dos ndices quanto das referncias bibligrcas pode mudar, mas eu gosto que seja como indicado neste texto (ou seja, o ndice um nmero entre colchetes e a referncia contm autor, livro, editora e ano). Uma outra fonte para formatao de referncias bibliogrcas [6]. Vale a pena consultar. Alis, aproveite e veja logo toda a srie Normas para apresentao de documentos cientcos[3, 4, 5, 6, 7, 8, 9, 10, 11]. Hoje cada vez mais comum ver informao na internet que vale a pensa ser usada como referncia bibliogrca. A diferena entre uma referncia em papel para uma referncia em internet que a primeira no pode ser apagada da noite para o dia, enquanto que a segunda pode, ou pode ainda mudar de endereo. Por isso, quando usar referncias da internet importante destacar o nome do artigo, o endereo e a data de acesso.

5 Figuras e tabelas
Quase todos os textos cientcos tem guras e tabelas. O problema que a maioria dos alunos acha que uma gura fala por ela mesma, e no coloca nenhum texto para explicar aquilo que o mais importante na gura (ou tabela). Vamos comear com guras. Ao incluir uma gura, necessrio que ela tenha um nmero (por exemplo, gura X.y - onde X o nmero do captulo e y um nmero seqencial. E abaixo dela, um texto curto - nunca maior do que uma linha. O texto deve conter uma referncia a esta gura e algumas explicao sobre a gura. A gura no fala por si. necessrio descrever a gura, em especial como a gura se relaciona com o objetivo do tema a ser explicado.

Na maioria das vezes um pargrafo necessrio para explicar uma gura. O aluno deve aproveitar a oportunidade de ter um pargrafo inteiro para explicar a gura para destacar aquilo que mais importante. Como exemplo, considere o seguinte trecho extrado de um texto: A gura 1 mostra que parte do programa em execuo ser abordado. Como pode ser visto, a rea de cdigo comea no endereo virtual 0x08048000. Como os diagramas deste texto consideram que endereo 0x00000000 est em baixo e o endereo 0xFFFFFFFF est em cima, o programa em execuo tem seu menor endereo em 0x08048000, e as instrues so copiadas do arquivo para este endereo para cima. Assim que a ltima instruo copiada, comea a rea de dados.

Figura 1: Programa em execuo na memria virtual - rea de texto e dados globais (formato ELF) Agora, vamos abordar tabelas. Na verdade, no h muito mais a acrescentar. Tabelas devem ser tratadas como guras, e deve haver um texto que explica a tabela. Quando uma tabela copiada de um outro texto, necessrio indicar de onde (referncia bibliogrca), e deve haver um texto explicando aquilo que for considerado importante. Porm, quando uma tabela includa para comparar coisas que foram examinadas no texto (por exemplo, o desempenho comparativo de duas solues para o mesmo problema), imprescindvel que o aluno descreva aqueles pontos mais relevantes. Por exemplo, ao comparar o desempenho de um algoritmo em uma mquina com um ncleo com o desempenho do mesmo algoritmo em uma mquina de N ncleos, e inte1 ressante destacar se o desempenho na mquina de N ncleos N , e se no for, explicar porque. Quando este tipo de tabela includo, muito comum que o texto explicativo ocupe vrios pargrafos.

Referncias
[1] Autor1, Nome do livro1, Editora, Ano [2] Autor2, Nome do livro1, Editora, Ano [3] Normas para apresentao de documentos cientcos: 1 - Projetos, Editora UFPR. [4] Normas para apresentao de documentos cientcos: 2 - Teses, dissertaes, monograas e outros trabalhos acadmicos, Editora UFPR. [5] Normas para apresentao de documentos cientcos: 3 - Citaes e notas de rodap, Editora UFPR. [6] Normas para apresentao de documentos cientcos: 4 - Referncias, Editora UFPR. [7] Normas para apresentao de documentos cientcos: 5 - Relatrios, Editora UFPR. [8] Normas para apresentao de documentos cientcos: 6 - Peridicos e artigos de peridicos, Editora UFPR. [9] Normas para apresentao de documentos cientcos: 7 - Livros e folhetos, Editora UFPR. [10] Normas para apresentao de documentos cientcos: 8 - Curriculum vitae e memorial, Editora UFPR. [11] Normas para apresentao de documentos cientcos: 9 - Redao e editorao, Editora UFPR.