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: 20180911

Indíce

  1. Worflow para Escrita de Textos
  2. Regras de Estilo
    1. Estilo para Programas Lineares
  3. Checklists
    1. Envio para Revisão
    2. Submissão do Texto
  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 para ajudar na escrita.

  1. Pense sobre os objetivos do seu texto e qual a narativa dele (qual história ele conta).
    • Seu texto sempre precisa informar alguma coisa e/ou convencer alguém de algo, leve isso em consideração.
  2. Quebre o seu texto em capítulos ou seções.
    • Artigos costumam ter seções como abstract, introdução, revisão bibliográfica, notação, resultados experimentais (quando aplicável) e conclusão, além de seções específicas para os resultados.
    • Teses, Dissertações e Relatórios técnicos costumam ter capítulos como introdução, preliminares e conclusão, além de capítulos específicos para os resultados.
    • Veja a estrutura de textos já publicados por pesquisadores mais experientes para entender a estrutura.
  3. Crie um esqueleto muito detalhado do seu texto.
    • Quebre os capítulos em seções, as seções em subseções e as subseções em parágrafos.
    • 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.
  4. 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, etc…
    • O importante é produzir uma primeira versão rapidamente mesmo que essa versão seja 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.
    • Não precisa escrever necessariamente em ordem já que alguns parágrafos são mais desafiadores do que outros (mas você vai precisar escrever todos eles eventualemente).
  5. 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ágragos, etc…
    • Corrija gramática e ortografia e melhore a notação.
  6. Repita o passo anterior várias vezes
    • 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.
  7. Lembre-se de aplicar as regras de estilo e usar as ferramentas sugeridas nessa página
  8. Revise mais algumas vezes…
  9. Siga os Checklists para o envio para revisão ou submissão
  10. Talvez revise mais algumas vezes…
  11. Envie o seu texto quando ele for o melhor que você consegue fazer

Regras de Estilo

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.

Checklists

Envio para Revisão

  1. Revisei o título e resumo para que permita ao leitor saber o que há de novo e importante no seu trabalho.
  2. Quebrei parágrafos muito longos em dois parágrafos.
  3. Quebrei frases muito longas (mais do que 4 linhas) em duas.
  4. Reescrevei frases que usem vozes passiva trocando para voz ativa dentro do possível.
  5. Defini todos os termos matemáticos que uso (dentro do bom senso).
  6. Segui as regras de estilo desta página
  7. Verifiquei se referencio no texto todas as imagens e tabelas.
  8. Verifiquei se os captions são descritivos e autocontidos, explicando o que a figura representa e notações usadas (por exemplo, o que as cores significam).
  9. Removi todas as contrações como “it’s”, “can’t”, etc, escrevendo a forma não contraída.
  10. Verifiquei se agradeço os projetos de pesquisa de todos os co-autores (quando aplicável)
  11. Fiz as correções sugeridas por um verificador ortográfico
  12. Fiz 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. Pedi para um amigo (preferencialmente do LOCo) para revisar o meu texto apontado o que não está claro ou incorreto e o que pode ser melhorado
  14. Fiz as correções sugeridas pelo amigo prestando atenção para não estragar os itens anteriores
    • Por exemplo, coloque o texto novamente no Grammarly
  15. Passei o chktex no documento e fiz as correções sugeridas
  16. Verifiquei 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.
  17. Desativei os links do PDF (os links de pular de página)
    • Eles atrapalham na hora de anotar no PDF
  18. Gerei a versão com as modificações usando o latexdiff

Submissão do Texto

  1. Verifiquei a Bibliografia
  2. Garanti que periódicos e conferências são citados sempre com o mesmo nome
  3. Padronizei se o primeiro nome dos autores é abreviado ou não
  4. Coloquei o DOI (digital object identifier) em cada artigo (dentro do possível)
  5. Verifiquei se todas as informações das referências estão completas
  6. Verifiquei se respeito o número de páginas
  7. Verifiquei se respeito as margens do documento
    • Dica: use o pacote showframe
  8. Verifiquei se respeito o estilo estabelecido pelo journal ou conferência.
    • Dica: em geral existe uma template a ser seguido
    • Dica: em geral existe 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.

Feramentas, Links e Pacotes Úteis

Algumas ferramentas e links úteis:

Alguns pacotes úteis de LaTeX:

Alguns pacotes úteis de Atom: