Your SlideShare is downloading. ×

Arte escrita tecnica

831
views

Published on


0 Comments
2 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total Views
831
On Slideshare
0
From Embeds
0
Number of Embeds
0
Actions
Shares
0
Downloads
0
Comments
0
Likes
2
Embeds 0
No embeds

Report content
Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
No notes for slide

Transcript

  • 1. Revista de Sistemas de Informação da FSMA n. 8 (2011) pp. 22-30 http://www.fsma.edu.br/si/sistemas.html A Arte da Escrita Técnica Armando Vieira Abstract—Neste trabalho são apresentadas as principais Escrevi este pequeno guia na esperança de ajudarregras sobre a arte e a técnica da escrita científica, em particular quem necessite redigir um trabalho técnico-científico,para a elaboração de um relatório a nível universitário, mas que sobretudo a nível universitário. As regras aqui colocadas sãopoderá ser útil na elaboração de outros tipos de documentos as mais usadas em trabalho deste tipo, mas a concisão inerentetécnico-científicos. São apresentados alguns princípios gerais e de um artigo impede a expansão e discussão total das mesmas.dados alguns exemplos de formas corretas e incorretas de escrita. As referências colocadas ao fim do texto servem como excelente complemento para as informações colocadas aqui.Palavras chave: escrita científica, relatórios técnicos,apresentações técnicas. II. OS MANDAMENTOS DA ESCRITA CIENTÍFICA I. INTRODUÇÃOE SCREVER bem é difícil mas necessário. Não é raro a escrita de um relatório ser a parte mais morosa de umtrabalho. Einstein escrevia bem mais lentamente do que A. Seja simples sem ser simplista Este é o segredo da escrita técnica. É forte o apelo ao uso de um estilo de escrita rebuscado recorrendo a termospensava – pouco mais de uma página por semana, quando complicados e expressões elaboradas. Nós o fazemosestava inspirado. inconscientemente, para impressionar, com a esperança de A escrita é uma tarefa mal amada, senão mesmo conseguir com isso obter mais seriedade e importância. É ummenosprezada, por muitos cientistas e engenheiros que erro grave! Um texto pomposo é difícil de ler, aborrece o leitorpreferem aplicar o seu tempo noutras atividades consideradas e turva a mensagem.mais úteis. Entretant, é errado pensar assim: escrever é o meio A escrita deve ser simples, objetiva e concisa; sem palavrasmais eficaz de organizar ideias e de as comunicar aos outros. a mais, expressões irrelevantes, apartes, divagações. ContudoAlém disso ajuda a ordenar o raciocínio e a construir modelos não deve omitir detalhes importantes. Entre diversasconsistentes. possibilidades para expor uma ideia escolha sempre a mais A qualidade da escrita é pois um fator determinanteno impacto do trabalho realizado. Depois de escrever é mais simples. Elimine todos os traços de pomposidade -fácil falar e expor o tema perante qualquer audiência. A escrita infelizmente muito comuns na nossa cultura. Resista à tentaçãoserve sobretudo para comunicar os resultados do seu trabalho: de impressionar o leitor com o seu saber enciclopédico. Sepode ser relatório técnico, um texto de revisão, ou um artigo quiser mostrar as suas habilidades literárias, então escreva umonde expõe as suas descobertas. Você pode ter tido uma ideia romance. Vejamos o seguinte exemplo:brilhante, ou realizado um trabalho excelente, mas se o Incorretoapresentar de uma forma atabalhoada, numa escrita confusa e “Como é sabido, hoje em dia, o problema dasem encadeamento lógico, não só poucos o vão ler até ao fim humanidade continua a ser, tal o foi na antiguidade, ocomo vão ainda ficar com suspeitas sobre a qualidade e de encontrar novas formas de energia que sirvam asveracidade do que leram. suas necessidades. Os combustíveis tradicionais, além Todo o esforço dispendido na escrita de um bom de muito poluentes, possuem reservas limitadas. Nesteartigo ou relatório é sempre bem empregue. Escrever pode, no contexto o gás natural afigura-se como uma das maisentanto, ser muito frustrante. Para evitar a frustração ao promissoras fontes de energia.”corrigir o seu artigo pela milésima vez, encare, logo à partida, Melhoresta tarefa como uma parte integrante de todo o trabalho e “Pelas reservas disponíveis, baixo preço e diminutadedique-lhe pelo menos 10 a 20 % do tempo total do projeto. poluição, o gás natural é hoje uma das principais fontes de energia alternativas ao petróleo.” 22
  • 2. Vieira, A / Revista de Sistemas de Informação da FSMA n. 8 (2011) pp. 22-30 e revisões atentas, feitas por si ou alguém da sua confiança, certamente que o seu trabalho terá, ao final, uma forma que lheA. Pense nas necessidades do leitor agrade. Ao escrever pense em quem será o seu leitor típico.Identifique o que ele já sabe sobre o tema e que explicações C. Seja específicoadicionais são necessárias. O objectivo na escrita técnica é Use, sempre que possível, números para precisar o seuexplicar o que é, como e porque funciona, o que descobriu ou raciocínio: medidas, estimativas, estatísticas, etc. Os númerosporque os resultados foram ou não os previstos. Adapte o grau apresentam informação e tornam o texto mais claro. Tentede profundidade e o nível do seu texto ao tipo de audiência evitar termos como muito, substancial, considerável. Emboraque espera ter. eles se adequem a malabarismos de linguagem, devem ser A não ser que esteja perante especialistas, nunca assuma que usados com parcimônia na escrita científica.o leitor está a par de todos os conceitos que são para si Evite generalidades e lugares comuns, como por exemplo,básicos. Se está na dúvida, use a bitola mais baixa. Para um “a poluição é uma ameaça ao planeta provocada pelaleitor generalista evite termos técnicos e expressões humanidade”. Especifique o tipo de poluição a que se estámatemáticas. Apresente somente o que ele precisa saber e não referindo, apresente valores e compare-os com dados de outrostudo aquilo que você sabe. Recorra a analogias que estudos.apresentem a sua mensagem num contexto familiar para o Cuidado com as conclusões - em matérias complexas, comoleitor. o impacto da poluição num ecosistema, é quase sempre difícil Se está escrevendo para uma revista científica da sua provar as relações de causa e efeito, mesmo quando nosespecialidade, o mais importante são os métodos e os parecem óbvias. Não caia na tentação de tirar conclusões semresultados detalhados. Entretanto, se escrever para uma revista que as possa comprovar empiricamente. Na dúvida seja menosmenos especializada deve dar mais explicações sobre o seu ambicioso assumindo conclusões mais específicas.trabalho e explorar todas as consequências. Aqui todo o cuidado é pouco. Evite opiniões extremas ou Se escrever para um jornal de grande circulação, deve ser tendenciosas. Se tem dúvidas em vez de “todos” escrevacapaz de despertar o interesse em pessoas sem conhecimentos “quase todos”, ou “a maioria”. Por exemplo, em vez de dizercientíficos. Para isso precisa não só de referir aplicações e o “a poluição dos afluentes danificou todo o ecosistema do rioimpacto social, como ainda recorrer a certos estratagemas Tejo”, diga antes “nos últimos 3 anos o nível de poluição docomo histórias, humor, analogias com fenómenos do dia-a-dia, rio Tejo quase que triplicou registando-se, durante essecartoons ou figuras atractivas. Aqui a imagem e a apresentação período, um decréscimo acentuado nas populações dasgráfica são muito importantes. espécies de peixe que habitam este ecosistema. Algumas Por exemplo, dizer que o Sol possui uma potência de 1026 destas espécies, como o Sável, terão sido eventualmenteW significa pouco mesmo para quem tenha bons extintas, não sendo por nós identificado um único exemplar.”conhecimentos técnicos, para já não falar da maioria da Estes termos podem no entanto ser usados em apresentaçõespopulação que nem saberá o significado de um número escrito mais generalistas, quando existem provas irrefutáveis ou tal foina forma de uma potência de dez. demonstrado. Não há mal nenhum em escrever este número, até o deve Apresente sempre definições claras dos termos usados, dosfazer por uma questão de rigor. Mas, logo de seguida, deve-o símbolos que apareçem nas equações, bem como a precisãopôr em perspectiva, por exemplo, explicando que este valor é com que obteve os valores, ou então as fontes de onde foramtão elevado que apenas num segundo o Sol produz tanta transcritos. Esclareça ainda quais são os pressupostos dos seusenergia como a que seria necessária por satisfazer toda a argumentos. Se eles são incorretos, as conclusões não podemhumanidade durante dez mil anos. Mesmo em apresentações ser suportadas. Indique como e em que condições obteve ostécnicas é sempre conveniente contextualizar os valores, seus dados e explique as limitações do seu trabalho.sobretudo se estes forem difíceis de assimilar. Especifique as prováveis fontes de erro. Sempre que possível quantifique-as. Por exemplo, não se limite a dizer: “aB. Crie o seu próprio estilo sala tinha muito ruído que perturbou a experiência da medição Só se pode avaliar a profundidade do conhecimento sobre da intensidade sonora de um altofalante”. Diga antes: “comoum tema depois de ser capaz de o descrever pelas nossas verificamos haver ruído de fundo no laboratório fizemos umapróprias palavras. É um erro tentar copiar o estilo de algum medida do nível sonoro com o altofalante desligado.autor favorito, mesmo que este lhe pareça muito bom. Verificámos que havia um nível médio de ruído de cerca de 50 Não tenha medo de escrever com as suas próprias palavras. dB, embora fosse algo irregular, podendo atingir por vezes 60Escrever bem é uma arte que leva tempo a aperfeiçoar; se não dB a 65 dB”.experimentar nunca poderá melhorar. Use palavras que Não começe a escrever ao sentir uma mínima vontade deconhece bem, que se encaixem no espírito da mensagem e que transmitir qualquer ideia. Pense bem se tem algo importanterespeitem as necessidades dos leitores. para dizer: uma ideia, uma experiência bem sucedida, um É normal a primeira versão não sair bem e serem cometidos relatório de actividades, uma opinião. Escreva após tervários erros. Mas com a ajuda dos modernos editores de texto adquirido conhecimentos suficientes sobre o tema e alguma 23
  • 3. Vieira, A / Revista de Sistemas de Informação da FSMA n. 8 (2011) pp. 22-30ideia bem formulada sobre o que vai expor. Pratique a escrita efetuadas”, fica melhor “As medidas obtidas devem serpois ela é um poderoso instrumento para estruturar o independentes da temperatura”. Negar a negação tem umpensamento. efeito lógico nulo. Lembre-se que deve focar a atenção do leitor sobre alguns • Use linguagem específica. Em vez de “instalou-se umaspectos relevantes e não adormecê-lo com uma coleção período de mau tempo”, prefira “choveu toda a semana”.enciclopédica de dados técnicos. Evite a todo o custo • Mantenha próximas palavras relacionadas.apresentar mais informação do que a estritamente necessária • Seja conservador: use um estilo de letra comum, como opara justificar o seu argumento. Todos os dados remanescentes “Times New Roman”, não use cor, não abuse dos sublinhadosdevem ser remetidos para uma bibliografia adequada. e carregados. Não use maiúsculas nem fontes de letra Em particular, numa apresentação oral, a sua missão não é “engraçadas”. Nomes e expressões estrangeiros aparecem emdizer tudo o que sabe, mas captar o interesse da audiência. itálico ou entre aspas.Deixe que os detalhes sejam revelados pelas perguntas ou pela • Evite o uso de parêntesis.leitura de um artigo escrito que poderá disponibilizar na • Use frases curtas, mas não exagere.Internet. • Independentemente das palavras intermediárias, o modo verbal deve conjugar com o sujeito. D. Respeite os seguintes pontos• Clareza: a clareza de exposição é dos melhores critérios Quanto ao conteúdopara avaliar se um tema foi bem compreendido pelo autor. • Evite a aliteração.• Objetividade: sempre que possível use números para • Evite jargão técnico e seja parcimonioso nas abreviaturas ouquantificar um conceito ou reforçar um argumento. Em vez de siglas. É irritante encontrar referências a siglas ou conceitos“muitos” diga exatamente quantos ou apresente uma desconhecidos do leitor. Existem algumas excepções, comoestimativa. “email” ou “world wide web”.• Completo: o texto deve transmitir uma mensagem de uma • Evite termos estrangeiros se puder usar uma expressãoforma completa, ou seja conter o necessário para ser portuguesa comum. Por exemplo, em vez de mutatis mutantiscompreendido. Cada frase deve ser completa; os argumentos use “de forma análoga”.devem seguir uma ordem que conduza à conclusão anunciada • Defina e explique o significado de todos os símbolos usadossem exagerar nos detalhes. bem como a origem de todas as equações. Faça-o• Coerência: qualquer pressuposto, extrapolação ou imediatamente após eles serem introduzidos no texto.generalização deve ser baseada com evidência suficiente. Evite • Evite usar mais palavras que as necessárias e não sejapalavras que assumam como provado algo que não o é, como redudante.“obviamente”, “com certeza”, “claro”, etc. • Evite expressões idiomáticas, frases feitas, clichês (trate-os• Honestidade: ninguém pode saber sobre tudo, mas verifique como se fossem uma praga!), citações, generalizações,se compreende aquilo que afirma. Não escreva algo que não coloquialismos e questões retóricas.entende só porque lhe parece importante ou bonito. Se copiou • Finalmente, lembre-se que o exagero é mais grave que ade um texto, refira-o explicitamente. modéstia.• Ordem: o leitor vai perceber melhor a sua mensagem se elafor apresentada numa sequência lógica. Lembre-se de que o III. AJUDE O LEITORseu artigo é uma ferramenta de comunicação de idéias e queuma grande parte de seus leitores o usará para aprender mais A. Decida o que o leitor precisa de sabersobre um assunto. Assim, a didática é uma parte fundamental Tente saber o máximo sobre os seus leitores, sobretudo se sãode seu artigo (veja a seção III para mais detalhes); especialistas ou um público generalista. Para um público mais• Rigor: evite erros de natureza técnica e muito menos generalista deve despender boa parte da apresentação numaortográfica. introdução abrangente para enquadrar o seu trabalho. Por• Versatilidade: não fique condicionado àquilo que estava à vezes isso exige uma mudança radical do texto.espera de obter na experiência. Os pressupostos do modelo Considere-se o seguinte exemplo que, para um especialistateórico podem não ser válidos. Nunca deixe de tentar explicar, em astrofísica, poderia ser apresentado da seguinte forma:ou pelo menos reparar, numa discrepância entre a teoria e a “Neste trabalho mostrámos que, ao remover a restrição daexperiência. velocidade da luz ser constante, somos conduzidos a uma nova representação do invariante de Lorentz que implica a E. Respeite ainda as seguinte regras discretização do espaço-tempo no quadro das equações de Einstein.”Quanto à forma• Use a voz ativa. Em vez de: “A leitura do termômetro deve Vejamos como esta frase extremamente hermética, poderiaser registada”, prefira “Registe a leitura do termômetro”. ser reescrita para ser lida por um leigo: “A teoria da• Escreva no presente. Evite sobretudo o condicional. Em vez relatividade de Einstein supõe que um raio de luz nos atingede “foi feito”, diga “fizemos” ou “fez-se”. Em vez de sempre à mesma velocidade, independentemente da nossa“podemos concluir”, use “concluímos”. velocidade. Embora tenha tido muito sucesso, esta teoria• Escreva pela positiva. Em vez de “Não é de esperar que o levanta algumas dificuldades importantes. Uma delas éaumento da temperatura tenha algum efeito nas medições explicar porque o universo é tão uniforme sabendo que 24
  • 4. Vieira, A / Revista de Sistemas de Informação da FSMA n. 8 (2011) pp. 22-30existiram regiões que, desde a sua origem, nunca puderam Tabela 1: Evite as seguintes frases que podem ter umainteragir entre si. Neste trabalho explicamos como a hipótese interpretação como a que se segue.de a velocidade da luz ter sido mais elevada quando da origemdo universo, pode explicar esta observação. Mostramos como Frases introdutórias Possível interpretaçãoisso conduz a uma nova teoria, mais geral que a teoria da Como é bem conhecido Eu pensorelatividade, e estudamos algumas das suas surpreendentesimplicações.” É evidente que Eu penso Ajuste também o nível de detalhe a incluir na exposição. Talvez seja verdade que Não sei o que pensarPor vezes é necessário uma explicação exaustiva de tudo, mas,na maioria dos casos, o essencial da escrita é centrado na Toda a gente sabe que Algumas pessoas pensam quefundamentação de algo novo, na interpretação dos resultados e Por razões óbvias Não tenho provasnas conclusões e implicações do trabalho realizado. Se estiver escrevendo um artigo de revisão deve elaborar Não existe dúvida que Estou convencido quesobre todos os detalhes do tema, incluindo um breve Como foi dito anteriormente Isto é supérfluolevantamento histórico. Num trabalho de investigação devecentrar-se no que descobriu de novo e remeter para a literatura O exemplo típico O exemplo que melhor setudo o que for relevante mas já conhecido. Se for um relatório adequatécnico, deve apresentar apenas o essencial da experiência e osresultados obtidos, tendo o cuidado de verificar se o mesmo Tanto quanto sabemos Podemos estar erradosestá completo. Para saber isso, faça a si próprio a pergunta “se Como sabemos Provavelmente não sabeder o meu trabalho para um especialista na área ler, este seriacapaz de compreender o que fiz?” Não deixe sem justificação afirmações que não sejam O princípio e o final são os pontos mais importantes paraóbvias, tendo o cuidado de definir cada termo ou conceito por ênfase num texto. O primeiro e o último parágrafo (anovo. Ajude o leitor a estabelecer uma cadência lógica entre introdução e as conclusões), são os que mais provavelmentetodas as frases, parágrafos e secções do seu texto. serão lidos. Dentro de cada parágrafo a primeira e a última Embora a escrita deva ser concisa, a inteligibilidade do frase são as mais importantes. Por isso, não inicie umtexto deve ser o critério supremo. Para explicar um conceito parágrafo com expressões, palavras ou interjeiçõesdifícil não receie acrescentar um parágrafo, uma seção ou um desnecessárias. Acabe-o com a conclusão da ideia que nele foiexemplo concreto. Se acha que algo pode parecer inaceitável exposta, mesmo correndo o risco de se repetir.ao leitor, apresente provas ou resultados suficientes para o Dentro de cada frase, as primeiras e as últimas palavras sãojustificar. Nunca assuma que o seu ponto de vista é óbvio aos as que ganham mais ênfase. Por exemplo, se quer dar relevo aoutros. “automático”, em vez de escrever “Propomos um método para a análise automática de diversas amostras”, escreva antes “É proposto um método para análise de diversas amostras de uma B. Como começar? forma automática”, ou então “Um método de análiseAs primeiras frases são as mais importantes do texto, quer para automático é proposto para análise de diversas amostras”.orientar o leitor no resto da leitura, quer para lhe prender a Escolha uma linguagem mais intensa, recorrendo a adjetivaçãoatenção. Diga logo no início o que fez e a que conclusões ou expressões mais pronunciadas para apoiar os seus pontoschegou. fortes. Não disperse o leitor com detalhes irrelevantes, Um truque comum é o da inversão, ou seja apresentar as informação que os leitores já conheçam, ou aspectosconclusões logo no início. Não desperdice as primeiras linhas: demasiado técnicos ou formais – por exemplo análise deuse-as para elucidar o leitor sobre a sua mensagem mais incertezas. Neste último caso remeta esses tópicos para umimportante, a sua ideia central, ou aquilo que descobriu de apêndice. Centre-se somente na mensagem fazendo o possívelnovo, mesmo que já o tenha feito num sumário - abstract em para manter o leitor atento.inglês. Dificilmente será capaz de captar a atenção do leitorcomeçando a escrever generalidades, seguindo uma mera C. Estilo e Ritmosequência cronológica dos acontecimentos, ou deambulandoem considerações já bem estabelecidas. Alguns cientistas pensam que o estilo não é importante na escrita técnica. Tal não é verdade. O estilo não é um2.3 Capte a atenção do leitor complemento mas faz parte integrante do texto. Vejamos algumas tópicos importantes.Um erro comum ao escrever um trabalho técnico é o autor Use de preferência frases curtas. Uma frase não deve terassumir que o leitor está interessado em ler tudo o que ele tem muito mais que 20 palavras. Frases longas dificultam a leitura.para dizer. Não caia neste erro! Esforçe-se por captar a Porém não abuse sob o risco de quebrar o ritmo da leitura. Poratenção, e o mais rápido possível! vezes uma frase longa, mas bem construída, é superior a várias frases curtas. Por exemplo, não escreva: “Cultivamos uma cultura de bactérias. Esperamos 20 h. Após esse tempo o 25
  • 5. Vieira, A / Revista de Sistemas de Informação da FSMA n. 8 (2011) pp. 22-30número de bactérias duplicou. Todas as células morreram no uso de palavras adequadas, da pontuação e da construçãodia seguinte. A cultura bacteriana tornou-se castanha.” estruturada de parágrafos. O sujeito da frase deve vir perto do verbo, sem interjeiçõesou outras considerações pelo meio. Se quer dizer mais alguma B. Palavras a maiscoisa escreva uma outra frase. Use poucos verbos na mesmafrase. O uso de palavras supérfluas é um erro mais comum do que o Mude de parágrafo quando muda de ideia. Não é a estética uso de palavras erradas. Frases curtas e concisas elucidam odo texto que dita a inclusão de um parágrafo mas sim a leitor enquanto que palavras desnecessárias apenas onecessidade de separação de ideias. confundem, distraem e aborrecem. Uma frase correta deve Use a pontuação para ditar o ritmo da escrita. Não abuse das conter apenas as palavras estritamente necessárias; cada umavírgulas ao distribui-las uniformemente pelo texto como se delas com um objectivo claro, veja por exemplo [7].tratasse de uma sementeira! Para verificar o ritmo da sua Use bom português. Não confunda “bom português” comescrita leia-a em voz alta. português erudito. Desde que não comprometa a clareza do Cuidado com as repetições e o excesso de adjetivação: não texto, recorra a expressões vernaculares para substituir termosreforça a ideia que quer transmitir, mas sim aborrece e demasiado técnicos. O uso excessivo de jargão técnicoconfunde o leitor. esconde, quase sempre, uma incapacidade de comunicar ou, Seja consistente nos tempos verbais. Se começar o relatório pior ainda, ignorância.em um tempo verbal, deve mantê-lo até ao final. Da mesma No entanto, use termos específicos e com significado bemforma deve ser consistente na forma verbal; se começa a definido em detrimento de outros mais vagos. Por exemplo,escrever na primeira pessoa do plural (“nós”) não deve passar palavras como “instinto” ou “libido”, embora possuam umpara a primeira pessoa do singular (“eu”). Há alguns anos era significado específico, foram de tal forma usadas que seregra os textos técnicos serem escritos na primeira pessoa do tornaram palavras demasiado vagas e o seu uso deve serplural, mesmo que a única pessoa que realizou o trabalho fosse evitado. Os termos vagos, usados para quase todos osapenas o autor. Hoje em dia essa regra está a cair em desuso, contextos, criam a ilusão de se compreender algo de que,sendo já comum o uso do “eu” realmente, não fazemos a mínima ideia. Quando está se diriginda a um público mais vasto use frasesoriginais e com imaginação. Estabeleça analogias curiosas e C. “Verborreia”tempere o texto com algum humor. A forma mais simples e Infelizmente o uso de palavras supérfluas, expressõeseficaz de fazer passar uma mensagem é contando uma história, pomposas e termos complicados é um hábito muito enraizadoum episódio, se possível dramático ou anedótico que esteja de na nossa portuguesa. Embora mais comum em áreas como oalguma forma relacionado com o tema. Por exemplo, Richard Direito ou a Economia, este hábito, tão nefasto, contagiaFeynman, para explicar a uma audiência o acidente que igualmente um grande número de engenheiros e cientistas.aconteceu ao Space Shuttle, usou um copo de água com gelo e Existem várias razões para se escrever desta forma. Uma é aum pedaço de borracha. Ao colocar a borracha no gelo esta ignorância do significado exato das palavras; outra resulta deficava menos elástica e desta forma toda a gente percebeu que uma confusão de ideias, ou a mera incapacidade de escrevero problema tinha sido provocado pela perda de elasticidade correctamente. Mas existem outras razões mais profundas parados Orings de um depósito de combustível do vaivem espacial. se povoar um texto de palavras vãs. Alguns pensam que escrever muitas palavras é explicar uma ideia, outros receiam dizer exatamente aquilo que pensam, outros ainda não têm IV. O USO CORRETO DAS PALAVRAS simplesmente nada a dizer.A escrita é um poderoso instrumento de persuasão. Uma A “verborreia” resulta de um esforço inconsciente paramensagem coerente apresentada num texto bem redigido pode evitar a simplicidade, como se isso retirasse mérito ao autor.ter um forte impacto nos leitores. Tão importante como as Está ainda muito enraizada a crença de que o uso de termos emideias é a forma como elas são apresentadas. A escolha das latim, palavras longas e rebuscadas e frases elaboradas podempalavras deve ser criteriosa com um sentido o mais próximo conferir uma maior autoridade e sabedoria ao autor. Palavras,possível do usual. Clareza é o critério supremo da escrita. ou expressões, estrangeiras são pretensiosamente inseridas para conferir ao texto a desejada erudição. A. Escrever não é o mesmo que falar A “verborreia” é uma praga que obscurece a mensagem e cria um distanciamento desnecessário com o leitor, mostrandoSe tentasse transcrever uma conversa oral, mesmo entre desta forma uma falta de respeito para com ele.pessoas eruditas, raramente obteria uma boa prosa. Embora oobjectivo seja o mesmo, escrever é muito diferente de falar. Na linguagem oral pode-se enfatizar uma ideia através da D. Conselhosrepetição ou introduzindo mais palavras que as necessárias. • Escreva pela positiva (em vez de pouco improvável useIsto porque a pessoa com quem comunicamos está à nossa provável).frente e a sua atenção está garantida; podemos sempre aferir se • Evite usar uma metáfora ou outras figuras de estilo.ela está acompanhando o que lhe comunicamos. Na escrita • Nunca use uma palavra grande quando uma pequena serve.estas estratégias são interditas. Aqui a ênfase é feita à custa do 26
  • 6. Vieira, A / Revista de Sistemas de Informação da FSMA n. 8 (2011) pp. 22-30• Se achar que pode cortar uma palavra do texto faça-o sem B. Gráficos, Figuras e Tabelasclemência. As tabelas ajudam a resumir a informação. Elas devem ser• Evite excesso de adjetivação, como “muito grande”, explícitas, se possível poderem ser interpretadas sem recurso“notável e admirável” ou “extremamente interessante”. ao texto. A informação contida nas tabelas e nos gráficos não• Evite palavras com o sufixo “mente”, como “realmente”, deve ser repetida no texto. Tabelas muito longas devem vir em“obviamente”, “claramente”, “evidentemente” ou apêndice.“naturalmente”; evite também expressões como “é lógico” ou Sempre que necessário inclua figuras que ilustrem algum“é natural”. aspecto do trabalho como, por exemplo, o dispositivo• Seja sensato, evitando posições muito fortes ou extremas. experimental usado. Preocupe-se mais com a clareza do que a fidelidade do desenho: um esquema simplificado com as E. Exemplo de má escrita principais componentes bem ilustradas é quase sempre mais elucidativo que uma fotografia a cores.A título de exemplo de uma má escrita apresento o seguinte Os gráficos são uma forma condensada de apresentartexto: inúmeros resultados. Além disso ajudam o leitor a “Os últimos anos viram mudanças no ensino numa compreender melhor os conceitos. Pense na melhor forma de escala impar em qualquer período anterior da apresentar os seus dados e tente condensar os valores no história da nossa educação. Tais avanços menor número possível de figuras. Tenha porém cuidado nos precisaram de um dispêndio monumental de casos onde pretende focar um aspecto particularmente dinheiro e recursos, e é interessante notar que relevante – nestes casos deve apresentar um gráfico separado. noutros países, como os Estados Unidos ...” Deve ter acesso a um programa de gráficos científicos com razoável qualidade. Embora algumas planilhas de cálculo, Erros: como o Excel, permitam fazer gráficos, a sua qualidade e• os anos não vêem facilidade de uso deixa muito a desejar. Para quem trabalha em• “Numa escala impar” significa ímpar. ambiente Windows pode usar o programa Origin e em Unix• “...em qualquer período anterior da história da nossa existe o programa gratuito xmgr ou então o gnuplot – umaeducação” é uma tautologia. Deve ler-se “na história da versão mais difícil de trabalhar mas muito eficaz. Paraeducação”. ambiente Windows e DOS existe um programa simples e muito• Mudanças são mais tarde referidas como avanços. prático, designado Easyplot.• Os avanços não precisam. Os eixos do gráfico onde são apresentados os dados devem• As despesas não podem ser monumentais. ter sempre unidades. Se não puder apresentar unidades, ou elas• “é interessante notar” é supérfulo. forem irrelevantes diga-o na legenda. Deve explicar o• Existe mais algum país como os Estados Unidos? significado de todas as curvas, no próprio gráfico ou então na• Não é referido o período de tempo a que o autor se refere. legenda. Para distinguir várias linhas use um tracejado ou uma espessura de linha diferente – evite a cor pois muitas pessoas não possuem impressoras coloridas.V. COMO ESCREVER UM RELÁTORIO TÉCNICO UNIVERSITÁRIO Existem várias formas de apresentar pontos experimentaisDe seguida apresento algumas considerações para escrever um num gráfico. O mais simples é um gráfico linear tipo “xy”. Serelatório de um trabalho laboratorial para estudantes está apresentando medidas, então cada registo corresponde auniversitários. Não se trata de uma lista de regras rígidas mas um ponto que deve ficar bem legível. Deve fazer os possíveisapenas de sugestões que acredito serem úteis. para obter a medida do erro associado a cada medição. A. Descrição do Trabalho Normalmente os programas gráficos apresentam esses erros como linhas verticais centradas no ponto com um Ao elaborar um relatório deve apresentar os seguintes comprimento total igual ao dobro do erro de cada valor.tópicos: Existem programas que desenham automaticamente linhas • Introdução ou sumário, onde se esclarece muito suaves que passam por todos os pontos do gráfico - splines. sucintamente os objectivos do trabalho. Cuidado, ao incluir estas linhas pois normalmente elas não têm • Exposição dos conceitos teóricos ou modelos que qualquer significado. Caso queira traçar uma linha suave deve serão testados. fazer um ajuste dos pontos, ou fitting. Por exemplo, o ajuste a • Descrição do arranjo experimental usado: o tipo de uma reta consiste em determinar os parâmetros a e b tal que equipamento usado, referindo apenas os aspectos y(x) = ax + b. Explique na figura que essa linha se trata de um técnicos mais importantes - precisão, sensibilidade, ajuste escrevendo na legenda quais os coeficientes desse qualidade e pureza dos materiais, etc. ajuste. Se essa curva corresponder a uma função analítica, • Apresentação em gráficos ou tabelas dos valores então deve explicitar a sua expressão matemática no texto ou obtidos. na legenda. • Cálculo das incertezas. Os gráficos com escala semi-logarítmica são usados quando • Análise crítica dos resultados e comentários. se está representando variáveis cujos valores apresentam • Conclusões. variações de várias ordens de grandeza. Por exemplo, o 27
  • 7. Vieira, A / Revista de Sistemas de Informação da FSMA n. 8 (2011) pp. 22-30número de bactérias numa colónia N pode crescer de uma 1, pois indica que temos uma precisão de mais duas casasforma exponencial: decimais no primeiro caso. N (t ) = N 0eat Na soma, subtracção, divisão e multiplicação de dois números o resultado tem a precisão da parcela que tiver aem que a é a taxa de crescimento e t o tempo. Se aplicarmos o precisão mais baixa. Por exemplo, se tivermos a seguintelogaritmo a ambos os termos da equação ficamos com: divisão: 1,2345/0,10 o resultado não deve ser apresentado ln( N / N 0 ) = at . como 12,345 mas antes como 12,3. Se o eixo das ordenadas for logarítmico iremos assim obter Existem várias fontes que conduzem à incerteza de umaum gráfico linear. Quando em ambos os eixos as variáveis medida. Erros de leitura de escala, erros aleatórios etiverem uma abrangência de várias ordens de grandeza, então sistemáticos. O erro da leitura de escala está associado àusa-se um gráfico com ambas as escalas logarítmicas. capacidade de medição do aparelho: é metade da menor Existem ainda os gráficos paramétricos onde x e y são divisão da escala do instrumento de medida.função de um único parâmetro t. Por exemplo as equações O erro sistemático pode estar relacionado com defeitos doparamétricas de uma elipse: x = a sin(t), y = b cos(t). equipamento ou com procedimentos incorrectos do Para representar uma função de duas variáveis f(x,y) é experimentador. Este tipo de erro pode e deve ser eliminadonecessário um programa com gráficos tridimensionais. Pode verificando atenciosamente todo o dispositivo experimental.optar-se por várias hipóteses: O erro aleatório deve-se ao facto de existirem diversos• construção de uma superfície tridimensional com factores sobre os quais não temos controlo e que influenciam polígonos que se ajustam continuamente. as medições. A sua medida é estimada pela variância:• Representação bidimensional por curvas de nível: gráfico N de contornos. ∑(y i − y)2• Sequência de linhas yz para vários valores de x. σ= i =1 Note que, para transformar um conjunto de pontos xyz para Num gráfico 3D, o programa precisa de efectuar um pré- em que yi são as medidas efetuadas, y é o valor médio dessasprocessamento para construir uma curva contínua que passe medidas, e N é o número de medições. Podemos diminuir osuavemente por todos os pontos. erro aumentando o número de medições N: para reduzir σ a metade temos de quadruplicar N. Quando temos um valor Notas: pequeno de medições (menor que 30) é comum usar no1. Prefira gráficos bidimensionais: são mais fáceis de ler e denominador N-1 em vez de N. interpretar. Os gráficos a três dimensões são úteis apenas Na maior parte das vezes temos medidas x e y e quando se quer apresentar uma visualização mais queremos saber a incerteza associada ao valor de uma qualitativa que quantitativa. quantidade que é função dessas medidas: f(x,y). O seu cÁlculo2. Prefira um gráfico em preto e branco, pois o uso de cores é feito com base na regra da derivada de uma função a várias levanta muitos problemas: ao tirar uma fotocópia o leitor variáveis. Assim, se tivermos medidas x0, e y0 com uma deixa de poder interpretá-los, as cores esvaem-se com o incerteza ∆x e ∆y , a incerteza da grandeza é dada por: tempo e são mais dispendiosas.3. Os gráficos de barras ou tipo queijo (pie) são raramente usados nas comunicações científicas e técnicas. Evite-os. 2 2  ∂f   ∂f 4. Numerar e legendar todas as figuras (por baixo) e tabelas ∆f ( x, y ) =  ∆x  +  ∆y  (por cima). Deve ser feito um esforço para que o leitor  ∂x   ∂y  possa interpretar a figura ou a tabela sem recorrer ao  x0   y0  texto. Por exemplo, se quisermos saber qual é a incertezaC. Incertezas associada ao valor da função f ( x, y ) = x / y 2 no ponto (x0 =Qualquer medição tem um erro associado. Os números exatos 1,75, y0 = 2,3), quando temos uma incerteza nas medidas ∆x =são uma abstração que apenas existe nos manuais. A realidade 0,02 e ∆y = 0,01, fazemos:é sempre conhecida com mais ou menos “qualquer coisa” que 2 2  1   2 × 1,75 traduz a nossa incapacidade de obter maior rigor na medição. ∆f =  2 0,02  +  3 0,01 = 0,01Este “qualquer coisa” pode significar uma precisão apenas na  2,3   2,3 primeira casa décimal ou ser uma precisão com mais de 10casas décimais. Casos há para os quais os valores são tão Para mais informações sobre este tema específico consulte odifíceis de obter que apenas nos é possível uma estimativa. trabalho online na referência [7]. Uma grandeza física deve ser escrita com o número de casasdécimas igual à sua precisão, nunca em número maior. Por D. Análise de Resultadosexemplo, escrever 3,983 significa que temos uma precisão em Pontos a considerar na análise de resultados:quatro dígitos. Note que escrever 1,00 é diferente de escrever • Apresente os resultados numa sequência lógica, que não é necessariamente aquela que foi seguida no laboratório. 28
  • 8. Vieira, A / Revista de Sistemas de Informação da FSMA n. 8 (2011) pp. 22-30• Os valores relevantes não devem vir dispersos no meio do • Percebeu tudo o que escreveu? texto mas surgir num gráfico ou tabela. • A introdução explica correctamente o que foi feito no• Comente os resultados: trabalho? • Verifique se os valores obtidos são aqueles esperados • Corte sem clemência frases e palavras supérfluas - pela teoria - dentro das margens de erro. verifique isso imaginando como seria a inteligibilidade do • Lembre-se que a experiência é soberana. Se os texto sem elas. valores são diferentes dos esperados pela teoria uma • Cada seção e cada parágrafo são relevantes e estão na das seguintes situações deve verificar-se (por ordem posição correcta? de probabilidade): ou você está cometendo um (ou • Os assuntos estão apresentados numa sequência ordenada vários) erro na experiência; ou existe um aparelho e com clareza? defeituoso; ou a teoria não é adequada; ou você • Os resultados que obteve fazem sentido? Comentou-os? descobriu um fenômeno novo! • As conclusões estão fundamentadas pelos resultados? • Faça referência a resultados negativos: se alguma • Não faltam referências? Estão todas correctas? experiência não teve os resultados esperados, apresente os resultados e tente encontrar uma explicação para esse fato. H. Escrita de unidades e equações• Se possível compare os valores com outras medidas para • Deixe um espaço entre o valor numérico e a unidade avaliar a consistência dos seus resultados. correspondente (50 W).• Diferenças que não são estatisticamente relevantes não • Não use um ponto depois da unidade a não ser que seja devem ser descritas como insignificantes. Improvável não parágrafo. é sinônimo de impossível. • No sistema português e francês a vírgula separa as unidades das décimas, enquanto no sistema anglo- saxônico é o ponto. Note que neste último caso a vírgulaE. Conclusões serve para separar unidades de milhares.Escreva as conclusões de forma que um leitor possa perceber o • Nunca acrescente s a um símbolo (m significa metro ouque de mais importante foi feito. Ou seja, as conclusões devem metros)descrever o que obteve de significativo neste trabalho. Refira o • Não deixe um espaço entre um prefixo e o símbolo (ms =que se conseguiu medir e que resultado se conseguiu ou não milisegundo)provar com base nas medições efectuadas. Se os resultados • Quantidades vetoriais são representadas em itáliconão são conclusivos ou contrariam o que era esperado diga-o rexplicitamente. carregado (força = F), ou com uma seta por cima ( F ). Proponha novas explicações ou novos modelos, mas • Símbolos e expressões matemáticas devem ser escritas emfundamente as suas afirmações com base em argumentos itálico, excepto as funções: sin(x).sólidos e plausíveis. • Os números e as unidades são escritas em estilo normal. • Centre e numere à direita as equações. • Se possível apresente todos os números com a mesmaF. Bibliografia precisão.A bibliografia aparece no fim do trabalho e deve vir numeradaou pela ordem que é referida no texto ou por ordem alfabéticados autores, dependendo do padrão estabelecido no veículo CONCLUSÃOonde será publicado seu trabalho. Existem algumas normas Este trabalho tentou mostrar a importância da escrita naque diferem ligeiramente na nomenclatura mas a mais comum elaboração e apresentação de trabalhos de natureza técnica ena literatura anglo-saxónica é a seguinte: científica. Mostramos que a escrita deve ser parte integrante • Livro: Autor, título (itálico), editora, cidade, ano de do esforço desenvolvido pelo estudante ou pesquisador para edição. Exemplo: C. Bishop, Neural Networks, que o seu trabalho possa ser melhor aceite pela comunidade e Oxford University Press, Oxford (1998). ter o impacto esperado. Foram abordadas várias questões de • Artigo: Autor(es), nome revista, volume (“bold”), linguagem, de forma, de estilo e sobretudo de conteúdos para número de página do início do artigo, ano (entre tornar a apresentação mais clara, lógica e compreensível. Os parêntesis). Exemplo: A. Vieira e C. Fiolhais, Phys. conceitos foram consolidados através dos vários exemplos Rev. B, 34, 1134 (1998). apresentados. • Página web use o endereço completo: Exemplo: http://cfc.fis.uc.pt/roteiroG. Pontos a rever antes da entrega do relatório REFERÊNCIAS• Imprima e leia todo o relatório, se possível em voz alta. [1] R. Barrass, “Scientists Must Write”, Chapman and Hall,• Existem erros ortográficos; números, fórmulas ou gráficos London (1978). errados; esqueceu-se de referir alguma coisa importante? 29
  • 9. Vieira, A / Revista de Sistemas de Informação da FSMA n. 8 (2011) pp. 22-30[2] W. I. Beveridge, “The Art of Scientific Investigation”, Vintage Books, New York (1950).[3] Sinclair Goodlad, “Speaking Technically”, London (1990).[4] A. Raimes, ”Keys for Writers”, Houghton Mifflin Company (1999).[5] W. Strunk e E. B. White, “The Elements of Style”, Allyn & Bacon (1979).[6] P. Cabral, “Erros e incertezas nas medições”, sítio da Internet, disponível no endereço http://www.peb.ufrj.br/cursos/COB783/ErrosIncertezas.pdf, último acesso em Dezembro/2011 (2004)[7] G. Volpato, “Método Lógico para Redação Científica”, Ed. Best Writing, São Paulo, Brasil (2011) 30