Guia de Escrita e Edição de Textos

O objetivo desta página é auxiliar os alunos com o processo de escrita e edição de texto, principalmente aqueles feitos em LaTeX e com o objetivo da publicação em periódicos e conferências ou como dissertação, tese ou relatório técnico.

O conteúdo dessa página está quebrado em partes com um índice a seguir. Há uma sugestão de workflow para a escrita de texto, um conjunto de regras de estilo a serem observadas na escrita do texto, uma checklist a ser cumprida pelo autor antes de enviar o texto para a revisão pelos orientadores ou co-autores e uma checklist a ser cumprida pelo autor antes de submeter o documento.

Esta página será atualizada conforme necessário e até poderá ganhar novas seções futuramente.

Última atualização: 2021-07-16

Índice

1. Workflow para Escrita de Textos
   1. Objetivo
   2. Primeiro Esqueleto
   3. Segundo Esqueleto
   4. Primeiro Rascunho
   5. Primeira Revisão
   6. Submeta para Revisão do Orientador
2. Regras de Estilo
   1. Regras de Estilo Soft
      1. Estilo para Programas Lineares
      2. Erros Comuns de Escrita (e Fala)
   2. Regras de Estilo Hard
3. Checklists
   1. Envio para Revisão pelo Orientador
   2. Checklist - Submissão do Texto para Journal/Conferência
4. Ferramentas, Links e Pacotes Úteis

Workflow para Escrita de Textos

Escrever bons textos é uma das coisas mais importantes em termos da pesquisa científica, pois é como divulgamos os resultados obtidos e como pedimos financiamento para a pesquisa (bolsas, projetos de pesquisa, etc.).

Assim, é muito importante desenvolver a técnica de escrita. Para ajudar, desenvolvi esse pequeno workflow de escrita.

Qualquer um dos passos pode ser discutido com o orientador

• Nunca fique empacado. Se travar, escreva para o orientador para ele ajudar com qualquer uma das partes a seguir.
• Se nunca assistiu, assista ao Vídeo da Ms. Simone Pedersen - A autorregulação da escrita como estratégia para melhor escrever e compreender (SAE)

Objetivo

Pense sobre os objetivos do seu texto e qual a narrativa dele. Qual história ele conta? Quem é o leitor? Como ele impacta o que é conhecido anteriormente? O que ele traz de novo? Como eu convenço o leitor de que o resultado é correto e relevante?

Primeiro Esqueleto

Quebre o seu texto em capítulos ou seções, formando um primeiro esqueleto ou outline do seu texto. Assim você saberá o que precisa estar no texto e pode pensar na ordem de apresentação conforme o Objetivo.

• Artigos costumam ter seções como: abstract, introdução, revisão bibliográfica, notação, resultados experimentais (quando aplicável) e conclusão. Podem ter também seções específicas para os resultados, sempre com títulos descritivos.
• Teses, Dissertações e Relatórios técnicos costumam ter capítulos como: introdução, preliminares e conclusão, bem como capítulos específicos para os resultados, um por assunto.
• Dica: Veja a estrutura de textos já publicados por pesquisadores mais experientes para entender a estrutura.
• Dica: Consulte o orientador sobre o primeiro esqueleto para ter uma opinião.

Segundo Esqueleto

Crie um segundo esqueleto muito mais detalhado do seu texto. A ideia é ser o mais granular possível e saber tudo o que precisa estar no texto e onde antes de começar a escrevê-lo.

• Quebre os capítulos em seções, as seções em subseções e as subseções em parágrafos até você saber tudo o que precisa ser dito.
• A ideia é ir cada vez mais especificando o que será escrito e qual é a ordem do texto.
• Uma dica é usar um itemize para listar os parágrafos e em qual ordem eles deverão aparecer.
• Outra forma é usando o pacote todonotes.
• Dica: Novamente, consulte o orientador sobre o segundo esqueleto para ter uma opinião.

Primeiro Rascunho

Comece a escrever os parágrafos sem se importar com a qualidade.

• Não se preocupe com a qualidade dos parágrafos nesse momento, apenas escreva! Não importa se está ruim, não importa se tem palavra escrita errada, se a gramática não está correta, se a notação não é boa, se tem termos não traduzidos ainda, etc.
• O importante é produzir uma primeira versão rapidamente mesmo que essa versão seja muito ruim.
• Se você estiver gastando muito tempo nessa etapa, por exemplo, voltando muito para rescrever frases, você está fazendo errado. Escreva a frase e siga para a próxima até ter o texto completo.
• Não precisa escrever necessariamente em ordem já que alguns parágrafos são mais desafiadores do que outros. Se ficar bloqueado, vá para um mais fácil. Mas é claro que você vai precisar escrever todos eles eventualmente…
• Figuras nesse momento podem ser feitas a mão e fotografada ou até mesmo trocadas por textos temporários apenas para indicar onde você terá uma figura e como.
  • Dica: o todonotes tem um comando para colocar uma imagem falsa
• Dica: Esse ainda não é o momento do orientador ler o seu texto para fazer uma revisão, você precisa fazer isso antes… Mas se tiver com dificuldades, quiser opiniões, etc., você deve, sim, consultar o orientador.

Primeira Revisão

Nesse ponto você tem uma primeira versão, basta então começar a revisar.

• Vá corrigido os parágrafos um a um.
• Pense se a ordem dos parágrafos está boa, se não falta conteúdo, se há nexo entre os parágrafos, etc.
• Corrija gramática e ortografia, melhore a notação.
• Repita a revisão várias vezes até estar satisfeito ou não saber melhorar
  • Lembre-se que você escreveu um texto ruim (propositalmente) no começo e, portanto, ele precisa de várias revisões.
  • Mas é mais fácil revisar do que escrever…
  • Se possível, dê um tempo entre uma revisão e outra. Você achará muito mais problemas no seu texto se lê-lo um ou dois dias depois da última revisão.

Submeta para Revisão do Orientador

1. Lembre-se de aplicar as regras de estilo e usar as ferramentas sugeridas nessa página
2. Se conseguir, peça o feedback de um colega de laboratório ou grupo de pesquisa.
3. Siga as Checklists para o envio para revisão ou submissão

Regras de Estilo

Há dois conjuntos de regras. As regras soft são para o momento em que ainda estivermos em revisões iniciais do texto. Sem elas, o texto fica pior escrito e mais trabalhoso de revisar. Já as regras hard são regras mais de apresentação e formatação, para o texto ficar mais bonito. Essas regras podem ser seguidas desde o começo, mas podem também serem deixadas para o final, próximo da submissão, já que elas são mais chatas de seguir.

Regras de Estilo Soft

• Faça um texto neutro ao gênero
  • Evite definir o gênero da pessoa no texto. Muitas vezes é possível rescrever o texto para evitar isso.
  • Use “they” no singular para referir a uma pessoa de gênero desconhecido em textos em inglês.
• Use itálico para definir termos, conceitos matemáticos e nomes de problemas.
  • O texto fica mais leve do que se usar negrito.
• Não coloque ponto final em títulos e seções.
• Não comece uma subseção imediatamente após começar a seção. Coloque algum texto entre a seção e a subseção.
  • Dica: o texto pode dizer o que será discutido nessas subseções.
• Não comece uma seção/subseção direta com ambientes de teorema, definição, etc., faça um texto explicativo antes.
• Coloque textos explicativos entre teoremas, definições, lemas, etc.
  • Assim o texto não fica tão seco.
  • Cuidado para não simplesmente repetir no texto o que será apresentado a seguir. Busque apresentar de duas formas diferentes, uma menos formal (no texto) e outra mais formal (na definição, teorema, etc.).
• Enumere as equações que precisam ser referenciadas no texto (e somente elas, a não ser que exigido pela conferência ou periódico).
• Sempre defina uma sigla antes de usá-la a primeira vez.
• Enumere lemas, teoremas, definições usando o mesmo contador, preferencialmente quebrando nas subseções.
  • Ex: Lema 3.2 vem após Definição 3.1.
• Como equações fazem parte do texto, não esqueça de colocar ponto final ou vírgula nelas conforme necessário.
• Use ponto final em captions de figuras e tabelas.
• Não use termos como é fácil ver que, claramente, é natural, naturalmente, etc.
  • Eles indicam preguiça em justificar os seus argumentos.
• Quando for citar vários artigos de uma só vez, faça apenas um \cite.
  • Ex: ao invés de Na literatura~\cite{fulano},~\cite{cicrano} e~\cite{beltrano} escreva Na literatura~\cite{fulano,cicrano,beltrano}.
  • Isso evita que apareça como [14], [15], [16], fazendo com que apareça como [14, 15, 16].
• Escreva Section 4.3 ao invés de section 4.3. Idem para figuras, tabelas, teoremas, lemas, definições, equações, etc.
• Se possível, evite itemize e enumerate, escrevendo o que precisa ser dito de maneira corrida no texto.
• Escreva algoritmos usando preferencialmente o pacote algorithmicx combinado com o algpseudocode.
• Escreva títulos de seção que são curtos e claros, e seja consistente em relação ao uso de maiúsculas.
  • Deixe a primeira letra de cada substantivo, pronome, verbo, adjetivo e advérbio em maiúsculas e a primeira letra de artigos, preposições e conjunções em minúscula (exceto se for a primeira palavra).
• Não comece frases com símbolos matemáticos e siglas.
• No seu texto considere as citações numéricas como se fosse algo invisível.
  • Por exemplo, não escreva “Em [1], os autores… “, escreve “Fulano et al. [1]… “
• Sempre coloque números do seu texto entre $$ (ex. $1$), mesmo quando o número estiver sozinho. Assim a fonte matemática é usada ao invés da fonte padrão.
• Não use texto todo em itálico em definições, teoremas, etc., a não ser que seja o estilo da conferência ou journal.
• Verifique se você colocou variáveis que ocorrem no texto entre $$ (ex. $n$). Isso afeta a fonte utilizada.
• No possível, evite usar muitos símbolos matemáticos que podem ser substituídos por texto (ex: “para todo”, “existe”, “pertence”, “contém”), principalmente no texto corrido (fora de equações, .).
• Faça tabelas bonitas usando o pacote booktabs.
  • Dica: leia documentação do booktabs (texdoc booktabs no terminal), ela explica o que são tabelas bonitas.
• Se for utilizar algum identificador com multiplas letras (nomes de função, de variáveis, etc.) crie uma macro da seguinte forma: \newcommand{\identificador}{\ensuremath{\mathit{identificador}}\xspace} (você precisa do pacote xspace para isso):
  • Isso evita que o espaçamento fique estranho. Veja a figura a seguir, onde na esquerda não foi usada a macro e na direita sim.
    

Estilo para Programas Lineares

Para escrever um Programa Linear bonito, utilize o ambiente alignat do pacote amsmath. O código abaixo gera o seguinte programa linear:

Código para gerar o programa linear:

\begin{alignat}{4}
\mathrm{(P)} \quad & \omit\rlap{minimize $\displaystyle \sum_{S \in \mathcal{S}} x_S$}\nonumber\\
                   & \mbox{sujeito a} && \quad & \sum_{S \in \mathcal{S}_i} x_S & \geq 1      &\qquad & \forall\, 1 \leq i \leq n \label{pl:cover}\\
                   &                  &&       &  x_S                           & \in \{0,1\} &       & \forall\, S \in \mathcal{S}\nonumber
\end{alignat}

Note que algumas coisas podem ser adicionadas ou omitidas. Na figura, estou dando o nome (P) para o programa linear, mas ele pode ser omitido no texto se não for útil. Linhas que não precisam de numeração deve utilizar o comando \nonumber.

Erros Comuns de Escrita (e Fala)

Regras de Estilo Hard

• Cumpra todas as Regras de Estilo Soft
• Evite a quebra de expressões matemáticas em duas linhas.
  • Dica: escreva ${expressão}$ e o LaTeX não quebrará a expressão.
• Evite que uma linha comece com um símbolo matemático.
  • Dica: use o ~, que em LaTeX é um espaço que não pode sofrer quebra de linha.
  • Ex: o conjunto~$A$ ao invés de o conjunto $A$.
• Evite que uma linha comece com um número de figura, de tabela, de seção ou de citação.
  • Dica: use o ~, que em LaTeX é um espaço que não pode sofrer quebra de linha.
  • Ex: na Seção~\ref{sec:intro}, Fulano~\cite{fulano}, etc.
• Em listas de figuras ou tabelas coloque nomes representativos para as figuras/tabelas ao invés do caption do texto.
  • Dica: No LaTeX faça \caption[nome na lista de figura]{texto}.
• Coloque o quadrado do QED na última linha da prova, mesmo se essa for uma equação.
  • Apenas deixe o QED em uma linha em branco se a linha de cima estiver completamente cheia.
  • Nesse caso, veja se não é possível rescrever o texto.
  • Veja o comando \qedhere.
• Dentro do possível use o posicionamento padrão de figuras no LaTeX.
  • Se não for possível, use a opção b (bottom) antes de usar a opção h (here).

Checklists

Envio para Revisão pelo Orientador

1. Revise se o texto foi escrito na primeira pessoa do plural e sempre no tempo presente.
   • Por exemplo: não diga que o artigo “apresentará” um novo algoritmo, mas sim que o artigo apresenta um novo algoritmo.
2. Revise o título e resumo para que permitir ao leitor saber o que há de novo e importante no trabalho.
3. Quebre parágrafos muito longos em dois ou mais parágrafos.
4. Quebre frases muito longas (mais do que 4 linhas) em duas ou mais frases.
5. Reescreva frases que usem voz passiva trocando para voz ativa dentro do possível.
6. Defina todos os termos matemáticos usados (dentro do bom senso).
7. Siga as regras de estilo desta página.
8. Verifique se referencia no texto todas as imagens e tabelas.
9. Verifique se os captions são descritivos e auto-contidos, explicando o que a figura representa e notações usadas (por exemplo, o que as cores significam).
10. Remova todas as contrações como “it’s”, “can’t”, etc, escrevendo a forma não contraída.
11. Verifique se agradece os projetos de pesquisa de todos os co-autores (quando aplicável).
12. Faça as correções sugeridas por um verificador ortográfico.
    • Editores de texto como o VSCode podem ser configurados para isso.
    • Você pode usar o pandoc para converter o seu texto para .doc e abrir no Word para verificar.
13. Faça as correções sugeridas pelo Grammarly (apenas se o texto for em inglês).
    • Cuidado, pois nem todas as correções sugeridas pelo Grammarly se aplicam!
14. Passe o chktex no documento e faça as correções sugeridas.
15. Verifique se o texto está com espaçamento duplo e coluna simples para a revisão.
    • Exceto no caso onde a revisão é pequena, próxima à submissão final.
16. Desative os links do PDF (os links de pular de página).
    • Eles atrapalham na hora de anotar no PDF.
17. Veja se um colega do seu laboratório ou grupo de pesquisa mais experiente pode ler o seu texto. Faça as alterações sugeridas por ele.
18. Gere a versão com as modificações usando o latexdiff.
19. Envie para o orientador.

Checklist - Submissão do Texto para Journal/Conferência

1. Verifique a Bibliografia.
2. Garanta que periódicos e conferências são citados sempre com o mesmo nome.
3. Padronize se o primeiro nome dos autores é abreviado ou não.
4. Coloque o DOI (digital object identifier) em cada artigo.
5. Verifique se todas as informações das referências estão completas.
6. Verifique se o texto respeita o número de páginas.
7. Verifique se o texto respeita as margens do documento.
   • Dica: use o pacote showframe
8. Verifique se o texto respeita o estilo estabelecido pelo journal ou conferência.
   • Dica: em geral, existe um template a ser seguido e um “Guide to the Authors” no site
   • Em alguns journals pode-se (ou deve-se) fazer a submissão em um formato de draft
9. Verifique se os projetos de pesquisa estão sendo corretamente mencionados.
10. Coloque os ORCid de todos os autores.

Ferramentas, Links e Pacotes Úteis

Algumas ferramentas e links úteis:

• Grammarly - permite revisar textos em inglês para a correção da gramática. Você pode colar o conteúdo do seu .tex (ou trechos) e fazer a correção. Apesar dele não entender LaTeX, ele ignora a maior parte sem problemas.
• Language Tool - Similar ao Grammarly, mas para também tem em português e outras línguas. Inclusive você pode instalar no seu editor de texto como VS Code, por exemplo.
  • Veja LTex, por exemplo, que dá suporte ao VSCode, Vim, Emacs e ao Sublime Text.
• The Grammar According to West - várias observações de escrita em inglês e/ou escrita matemática que você deve considerar na hora de escrever.
• Mathematical Writing by Donald E. Knuth, Tracy Larrabee, and Paul M. Roberts - mais observações importantes sobre escrita e estilo.

Algumas ferramentas úteis para LaTeX:

• Detexify - permite desenhar um símbolo de LaTeX e ver qual é o comando associado e qual pacote deve ser importado.
• betterbib - melhora as suas referências bibliográficas.
• chktex - verifica o arquivo .tex por erros de estilo.
• texdoc - permite acessar a documentação dos pacotes instalados via terminal (similar ao man).

Alguns pacotes úteis de LaTeX:

• todonotes: permite adicionar tarefas a serem feitas no artigo.
• booktabs: permite fazer tabelas mais bonitas.
• algorithmicx e algpseudocode: permite escrever algoritmos em pseudocódigo.
• showframe: mostra as margens do documento para ver se você está estourando a marge.
• tikz: permite criar figuras bonitas diretamente no LaTeX.