Melhorando a Escrita Científica

Vania Bogorny(Material baseado no livro de Justin

Zobel: Writing for Computer Science)

Artigo

• Um artigo cientifico apresenta ideias , e seu conteúdo pode permanecer relevante por anos, e se publicar em bom evento ou revista, pode ser lido por milhares de estudantes e cientistas

• Se as ideias estão claras, o artigo deve ser fácil de ler

• Mas o problema eh que a maioria escreve mal

Consequências da má escrita

• Todo trabalho mal escrito tem:– Ambiguidade que leva ao não entendimento– Omissões frustração– Não claridade leva o leitor a sofrer para reconstruir a

intenção do autor• Esforço usado para entender a estrutura ou sintaxe

das sentenças eh esforço não usado para entender o conteúdo

• Uma apresentação fraca (preguiçosa) do texto leva o leitor a pensar que o trabalho não eh serio

Consequências da má escrita

• Poucos cientistas são escritores natos• A habilidade de escrever bem eh a chave da

ciência, e escrever só se aprende praticando• Eh possível escrever bons artigos seguindo os

passos básicos: organização lógica, sentenças concisas e revisão de problemas

• Como muitas habilidades, a escrita melhora com a prática, e principalmente, o desejo de aceitar e aprender com as criticas

Regras para uma boa Escrita

• A escrita cientifica deve ser objetiva e precisa.• Palavras que que expressam ambiguidade,

metáforas, sensualidade não são apropriadas em trabalhos científicos.

• Uma linguagem direta e simples eh a mais adequada, e ela segue regras simples como:– Descreva UMA ideia em cada frase ou parágrafo,

com um tópico por seção

Regras para uma boa Escrita– Use uma organização lógica e simples de compreender– Use palavras curtas– Mantenha parágrafos não muito longos– EVITE: uso de palavras que não tenha certeza do

significado e GIRIAS– EVITE excesso, tanto em comprimento, quanto em estilo– Omita qualquer material que seja desnecessário– Seja sempre especifico, não vago– Apenas quebre estas regras se existir uma boa razão

para isso

Voz Passiva• Evite o uso excessivo de afirmações indiretas (voz passiva),

principalmente quando eh necessário indicar QUEM ou O QUE a executaExemploX The following theorem can now be proved. We can now prove the following theoremX Tree structures can be utilized for dynamic storage of terms Terms can be stored in dynamic tree structuresX The detection of stops in the candidates was made using the

algorithm CB-SMoTThe stops were detected in the candidates using the algorithm CB-

SMoT

Voz Passiva• O estilo DIRETO eh mais fácil de ler• Se for necessário usar voz passiva, use, mas a total ausência

de voz ativa torna a leitura chata, menos prazerosa e pesada

• Em ingles, evite usar “this paper shows” ou “this section argues”. USE In this paper WE show– Sempre que for falar do SEU trabalho, use o termo WE

• Use o WE sempre que falar do seu trabalho, principalmente para diferenciar o seu trabalho dos outros artigos

Uso do We

• Contudo, em alguns casos o uso do WE eh incorreto:– Exemplo: when WE conducted the experiment it

showed that our hypothesis was correct• Esta frase da a entender que se outra pessoa executar o

experimento ele se comportaria de maneira diferente– A frase correta seria: The experiment showed that

our hypothesis was correct.Sempre que se referir aos autores do seu trabalho use WE, nunca I

Referencias e Citações

• Sempre que houver um estudo sobre algo afirmado, não a OPINIAO de alguém, então cite o estudo

• Afirmações ou CLAIMS, que vc acredita, mas que não vem de outros trabalhos, escreva de forma que demonstre isso. Por exemplo:

X Most users prefer the graphical style of interface We believe that most users prefer the graphical style of interfaceX Another possibility would be a disk-based method, but this approach is

unlikely to be successful Another possibility would be a disk-based method, but our experience

suggests that this approach is unlikely to be successful

Referencias e Citações

• Você sempre precisa explicar o relacionamento do seu novo trabalho com os trabalhos existentes:– mostrando como seu trabalho adiciona conhecimento

novo em cima do conhecimento já existente– mostrando COMO ele difere de outras contribuições

publicadas em artigos relevantes

• Todas as referencias no final do seu artigo devem estar citadas e descritas no seu artigo

•

Referencias e Citações

• Trabalhos relacionados tem 3 funções principais:– Ajudam a demonstrar que o seu trabalho eh inédito: CLAIMS de

originalidade são muito mais convincentes no contexto de referencias a trabalhos existentes

– Demonstram o seu conhecimento sobre os trabalhos na sua área de pesquisa, ou seja, na área do seu artigo: isso ajudará o revisor a julgar se seus argumentos são confiáveis

– São ponteiros para outras leituras• Antes de incluir uma referência veja se ela será útil para o

revisor. Ela precisa ser– Relevante– Atualizada– Facilmente acessivel– necessaria

Referencias e Citações

• Se o numero de referencias eh limitado, prefira citar artigos de revistas ao invés de conferências, e artigos de conferências ao invés de relatórios de pesquisa

• Evite referências a sites web, comunicações privadas ou fóruns ou palestras. Se for necessário, use nota de rodapé

• NAO use referências quando o conhecimento já eh consenso. Por exemplo: tabelas em bancos de dados tem acesso muito mais rápido pelo uso de índices

Referencias e Citações

Como usar referências:• According to Palma (Palma et al 2008) et al eh usado

quando o trabalho tem mais de 3 autores• Segundo Palma (Palma et al 2008)..• Palma (Palma et al 2008) propos um metodo• Palma & Torres em (Palma & Torres 2005) propuseram…• Em (Palma & Torres 2005) foi proposto um método• Palma [16] has used an approach in which Como NAO usar referencias(Palma et al 2008) propos um metodoSegundo (Palma et al 2008) …Other work [16] has used an approach in which

Referencias e Citações

Referências a artigos de revista:• Use sempre: os nomes dos autores, o titulo do artigo, o ano, o

volume, o número e o número de paginas• O NOME da REVISTA deve ser completo, nao abreviadoExemploX T. Wendell, “Towards trajectory outlier detection”, T.GIS, 34 T. Wendell, “Towards trajectory outlier detection”,

Transactions in Geographic Information Systems, 34 (3): 217-222, November 2014

Da mesma forma, em artigos de congressos o nome da conferencia deve ser COMPLETO, incluindo ano, número de páginas, título e autores

Parágrafos

• Um parágrafo consiste de uma discussão de um único tópico ou assunto

• O assunto do parágrafo deve estar na primeira frase, sendo o restante do parágrafo usado para explicar/justificar ou dar exemplo

• Toda frase num parágrafo deve ser referente ao assunto introduzido no início do parágrafo

• A última frase tem o maior impacto entre as frases do corpo do parágrafo, então preste atenção na ordem das frases.

Paragrafos

• Parágrafos longos indicam que várias frases intermediárias estão enroladas (não claras)

• Se um parágrafo longo pode ser dividido, quebre-o

• Nunca faça parágrafos de mesmo tamanho, isso torna a leitura chata e monótona

Paragrafos Iniciais

• Os parágrafos introdutórios de uma seção ou capítulo irão definir a atitude/impressão do revisor para o restante do artigo. Portanto: INICIE BEM!

• Todo documento deve ser editado com cuidado, mas os parágrafos iniciais são os mais importantes, pois eles criam a BOA ou MÁ impressão sobre TODO o texto.

Parágrafos Iniciais• Como NAO iniciar a primeira frase de um artigo:

X This paper does not describe a general algorithm for transactions General-purpose transaction algorithms guarantee freedom, but can

be inefficient. In this paper we describe a new transaction algorithm that …..

• Os parágrafos iniciais precisam ser compreensíveis para qualquer tipo de leitor, pois mesmo que o leitor nao compreenda o seu metodo, ele poderá compreender o resultado– Por isso: deixe detalhes complexos para o meio do artigo

• Escreva o que você fez sem entrar em detalhes de como foi feito.

Parágrafos Iniciais

• Nao inicie o artigo dizendo “ In this paper…” Inicie falando do problema, e depois diga a proposta do artigo em relação ao problema. Exemplo:X In this paper we describe a new programming language

with matrix manipulation operatorsMost numerical computation is dedicated to

manipulation of matrices, but matrix operations are difficult do implement efficiently in current programing languages. In this paper we describe a new programming language with matrix manipulation operators

Parágrafos Iniciais• Nao inicie o artigo dizendo que um tópico é popular ou que

um problema é importante . Exemplo:X The use of digital libraries is increasingly commonX It is important that the cost of disk accesses is reduced in query

processingEsse tipo de afirmação contextualiza mas perde em

motivação. Solução melhor: Digital libraries provide fast access to large numbers of

documents Query processing can involve many disk accesses.

Parágrafos Iniciais: a contextualização

• Os primeiros parágrafos precisam contextualizar e convencer o leitor de que artigo será intessante. Então eles precisam dizer claramente o tema do artigoX Muitas interfaces de usuário são confusas e pobremente

organizadas. Interfaces são superiores se desenvolvidas de acordo com princípios rigorosos

Muitas interfaces de usuário são confusas e pobremente organizadas. Este artigo demonstra que interfaces são superiores quando desenvolvidas de acordo com princípios rigorosos.

Ambiguidade

• Vefique ambiguidade das sentenças– Isso normalmente é uma tarefa difícil no nosso próprio

textoX The compiler did not accept the program because it

contained errorsThe program did not compile because it contained errorsX There is a new version of the operating system, so when

using the fetch utility, the message errors can be ignored (ambiguidade: when using)

There is a new version of the operating system, so the fetch utility error messages can be ignored

Ambiguidade

• Problemas com o ITX The machine crashed and it was necessary to reboot it

(it não é ambíguo mas usado nas 2 frases)The machine crashed and a reboot was necessary OUA reboot was necessary because the machine crashedX There is a new version of the operating system, so

when using the fetch utility, the message errors can be ignored

There is a new version of the operating system, so the fetch utility error messages can be ignored

Frases

• Frases devem ser curtas, não mais de uma ou duas linhas

• Não tente dizer demais de uma só vez

Escolha de Palavras

• May, might, can • Não use may ou might quando o sentido for

the can. As 3 palavras significam poder, entretanto

• Use MAY para indicar escolha pessoal e CAN para indicar capacidade. Exemplo Users can access this facility, but may not wish to

do so

Escolha de Palavras

• A falta do ‘that’ pode deixar a frase confusaX It is true the result is hard to generalize– It is true that the result is hard to generalize

• O ´the´é muitas vezes utilizado demais. Se a remoção dele não muda o sentido da frase, remova-oX A well known method that has been used to measure the

similarity between trajectories is the DTWA well known method that has been used to measure the

similarity between trajectories is DTW

Escolha de Palavras

• Which, that, the• Nao usar ‘which’ quando deve ser ‘that’– X There is one method which is acceptableThere is one method that is acceptableThere are three options, of which only one is

tractable

Palavras Repetidas• A repetição de uma palavra é chato quando faz o leitor sentir que leu a

mesma frase duas vezes ou leu uma frase e seu inversoX Ada was used for this project because the underlying operating

system is implemented in Ada Ada was used for this project because it is the language used for

implementing the underling operating system

Remova a repetição quando a palavra é usada com diferente sentido ou quando uma palavra e seu sinônimo são usadas juntasX Values are stored in a set of accumulators, each initially set to zero

Values are stored in a set of accumulators, each initialized to zero

Plural

• Um erro comum do uso da lingua inglesa é o plural• O maior erro: substantivo no plural + verbo para

singular e vice-versa. ExemploX The instructions IS √ The instructions AREX The instruction are √ The instruction is

• Classes não precisam de pluralX These kinds of algorithms are irrelevantThese kinds of algorithm are irrelevantX Sistemas de Informações GeográficasSistemas de Informação Geográfica

Abreviacoes

Escrevendo o Abstract

• O abstract precisa estar perfeito, sem nenhuma palavra desnecessaria