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á 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 pelo 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: 2020-08-11

Indíce

  1. 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
  2. Checklists
    1. Envio para Revisão pelo Orientador
    2. Checklist - Submissão do Texto para Journal/Conferência
  3. Feramentas, Links e Pacotes Úteis

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

Regras de Estilo Hard

Checklists

Envio para Revisão pelo Orientador

  1. Revise o título e resumo para que permitir ao leitor saber o que há de novo e importante no meu trabalho.
  2. Quebre parágrafos muito longos em dois parágrafos.
  3. Quebre frases muito longas (mais do que 4 linhas) em duas.
  4. Reescreva frases que usem vozes passiva trocando para voz ativa dentro do possível.
  5. Defina todos os termos matemáticos que uso (dentro do bom senso).
  6. Siga as regras de estilo desta página.
  7. Verifique se referencio no texto todas as imagens e tabelas.
  8. 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).
  9. Remova todas as contrações como “it’s”, “can’t”, etc, escrevendo a forma não contraída.
  10. Verifique se agradeço os projetos de pesquisa de todos os co-autores (quando aplicável).
  11. Faça as correções sugeridas por um verificador ortográfico.
  12. 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!
  13. Passe o chktex no documento e fiz as correções sugeridas.
  14. 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 a submissão final.
  15. Desative os links do PDF (os links de pular de página).
    • Eles atrapalham na hora de anotar no PDF.
  16. Gere a versão com as modificações usando o latexdiff.

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 (se possível).
  5. Verifique se todas as informações das referências estão completas.
  6. Verifique se respeita o número de páginas.
  7. Verifique se respeita as margens do documento.
    • Dica: use o pacote showframe
  8. Verifique se 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: