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

Indíce

  1. Worflow 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. Feramentas, Links e Pacotes Úteis

Worflow para Escrita de Textos

Escrever bons textos é uma das coisas mais importantes em termos da pesquisa científica pois é a forma como divulgamos os resultados obtidos e a forma 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

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 de acordo com o Objetivo.

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.

Primeiro Rascunho

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

Primeira Revisão

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

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 os 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

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)

Termo Errado Termo Correto Observação
Variation Variant Quando nos referimos a um problema próximo, uma variante.
Viable Feasible Quando falamos de uma solução viável.
The optimal solution An optimal solution Em geral, existem mais de uma solução ótima para um problema.
Algoritmo aproximativo Algoritmo de Aproximação  
Algoritmo aproximado Algoritmo de Aproximação  
Algoritmo 2-aproximado 2-aproximação A palavra Algoritmo é omitida
et. al et al. Vem do latin et alii, et aliae, et alia (“e outros” no masculino, no feminimo e de gênero neutro) e estamos abreviando a segunda palavra.

Regras de Estilo Hard

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.

Feramentas, Links e Pacotes Úteis

Algumas ferramentas e links úteis:

Algumas ferramentas úteis para LaTeX:

Alguns pacotes úteis de LaTeX: