Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Recommendations on Paper Writing

Guilherme Avelino edited this page May 4, 2022 · 15 revisions

Software

  • Latex: Miktex
  • PDF Viewer: SumatraPDF (a vantagem é que ele atualiza o pdf automaticamente, após a formatação; isso não acontece com o Acrobat)
  • Editor: TeXnicCenter (corretor ortográfico: Tools -> Options -> Spelling -> Check spelling while typing)
  • Gráficos: R

Estilo, Formatação e Layout

  • i.e. => The states on the west coast, i.e.,~Washington, Oregon, and California ... --- veja que é ponto, virgula e um til colado na palavra seguinte
  • aspas => use a macro \aspas, descrita abaixo.
  • e.g. => I like sweet foods, e.g.,~chocolate. --- veja que é ponto, virgula e um til colado na palavra seguinte
  • etc sempre tem virgula antes e ponto depois, mesmo quando entre parenteses => Many recommendations (e.g.,~D18, D20, D21, A4, etc.) include a suggestion ...
  • Em listas com três ou mais elementos, existe uma vírgula antes do "and" => We sell books, videos, and magazines.
  • Travessão => The proposed approach---called APIMiner---receives as input a list of methods. --- veja que são três sinais de menos, colados na palavras antes e depois
  • footnotes => Creating a footnote is easy.\footnote{An example footnote.} --- veja que vem depois do ponto final e veja que no footnote existe um ponto final também.
  • \cite preferencialmente no final das frases (antes do ponto final) e com um ~ antes, no lugar de espaço => Harman and Tratt showed how to achieve a better combination of metrics~\cite{HarmanT07}.
  • Em modo matemático ($ ... $) toda sigla com mais de uma letra (ex: NOM) deve aparecer entre \mathit{}. Exemplo: $NOM$ => $\mathit{NOM}$ -- caso contrário, o latex põe espaços entre N, O e M.
  • Evite linhas viúvas (última linha de um parágrafo com uma ou duas palavras apenas).
  • Evite parágrafos curtos, com menos de 4 linhas.
  • Evite muitas itemizações.
  • Números menores ou iguais a dez por extenso => It consists of three fields --- e não 3 fields.
  • Normalmente, primeira letra de títulos de capítulos, seções e subseções em maiúsculo. Logo, é estranho: \section{Qualitative Analysis} e depois \section{Quantitative analysis}

Inglês

  • Evitar contrações, como don't, doesn't, won't => do not, does not, will not.
  • cannot vs can not vs can't: prefira cannot.
  • Evite repetir palavras, use um [http://thesaurus.com/ Thesaurus] para procurar por sinônimos.
  • Use "linking words" para conectar frases (however, moreover, additionally, besides, etc). Uma boa lista pode ser encontrada em [http://www.essayzone.co.uk/blog/how-to-begin-a-new-paragraph-useful-linking-words-and-phrases/ this link].
  • Siglas tem plural => APIs, SPLs, BPMSs --- veja que tem "s" mesmo quando a sigla termina em "s".
  • Software não tem plural; nunca escreva, portanto, "softwares". Uma alternativa é escrever "software systems".
  • et al. significa "e outros", logo verbo depois vem no plural => Smith et al.~show ... --- veja que é "show" e não "shows"; veja também o ~ no lugar do espaço
  • Since vs Because: “Since” refers to time. “Because” refers to causation => Since I quit drinking I’ve married and had two children. Because I quit drinking I no longer wake up in my own vomit.
  • that (se retirado, muda o sentido da frase) e which (pode ser retirado sem mudar o sentido, normalmente fica entre vírgulas) => The house that is painted pink has just been sold. The house, which is painted pink, has just been sold. (nessa segunda frase o leitor já sabe qual é a casa).
  • Quando inicia uma frase "This" sempre pede um substantivo depois (ou seja, "this" tem que ser traduzido sempre para "esse/essa" e nunca para "isso") => This is an indicative ... (errado). This difference is an indicative ... (certo)
  • "The" (artigo definido, refere-se a uma instância bem específica de alguma coisa); "a/an" (artigo indefinido, refere-se a qualquer instância de uma coisa) => "Let's read the book," (i.e., a specific book). "Let's read a book," (i.e., any book)
  • Em related work, usar "simple past" em vez de "past participle". Exemplo: Di Lucca et al.~investigated the use of .... Weib developed a technique for ... Runeson and colleagues used a natural language approach ...

Tabelas e Figuras

  • Em tabelas, a legenda fica no topo; em figuras, na parte de baixo.
  • Apenas a primeira letra de legendas é maiúsculo (isto é, legendas não são títulos).
  • Em tabelas, títulos das colunas em negrito e centralizados. Para centralizar => \multicolumn{1}{|c|}{\bf Titulo}
  • Figure, Section etc com primeira letra maiúscula e sem "the" antes => Figure~\ref{fig:approach} shows .... --- veja tambem o ~ antes, no lugar de espaço.
  • Em labels de figura e seção, normalmente usar um prefixo "fig:" e "sec:" => Figure~\ref{fig:approach}, Section~\ref{sec:evaluation}
  • Posição no texto: Preferencialmente, figuras e tabelas devem aparecer logo depois do parágrafo em que são citadas pela primeira vez no texto. Se isso não for possível: (a) no topo da página seguinte; (b) no topo da própria página em que são citadas.
  • Latex para forçar posicionamento de uma figura no topo da página: \begin{figure}[!t] -- !t= forçar topo
  • Latex para forçar posicionamento de uma figura no ponto exato onde ela foi definida no texto: \begin{figure}[!h] -- !t= forçar here

Macros

Macros que costumamos usar (copiar para o .tex, antes de \begin{document}):

  • \newcommand{\aspas}[1]{{``#1''}} --- usar sempre que precisar de aspas => ... \aspas{essas palavras estão entre aspas}
  • \newcommand{\mcode}[1]{$\tt #1$} => no corpo de um parágrafo, usar para nomes de classes, variáveis, métodos => The class \mcode{CustomerDAO} is used to persist customers.

Gráficos

  • Todos os gráficos em PDF (pois é um formato vetorial, que facilita zoom).
  • Preferencialmente, gerar os gráficos usando o R.
  • É possível cortar as as margens extras de um gráfico diretamente usando "trim" no "\includegraphics" da seguinte forma:
\includegraphics[trim={0 Xcm 0 Xcm}, width=\textwidth]{arquivo.pdf}

Imagens

  • Ao contrário de gráficos, imagens (por exemplo, um screenshot) podem ser em PNG, preferencialmente em uma resolução bem alta, para faciltar zoom.

Versão Camera-ready (& Embedded Fonts):

  • Importante: Não usar nenhuma fonte "não-incorporada" (embedded), como Helvetica. Caso contrário, o pdf não passa no validador de pdf da IEEE.
  • Para verificar se todas as fontes estão embedded: Adobe Acrobat -> File -> Propriedades -> Fontes -> "Codificação: Incorporado" (para todas fontes)
  • Programa que "embute" fontes: Evince (para Ubuntu; essa é a alternativa que funcionou em 2018/2019). Esse programa abre um pdf e depois salva uma nova versão dele com todos as fontes "embutidas"; pdfs com embedded fonts são normalmente requeridos quando se envia a versão camera-ready de um paper; principalmente se a conferência for IEEE CS. Seguem instruções detalhadas de uso:
    • Abrir o arquivo (pdf) no Evince.
    • Selecionar a opção para imprimir para arquivo: "Arquivo" >> "Imprimir" >> "Imprimir para arquivo" (Figura 1).
    • Na tela exibida, acessar a aba "Configurar página". Em seguida, selecionar a opção "Carta Americana" ou "US latter", em "Tamanho do papel" (Figura 2).
    • Imprimir.
  • Outras alternativas:
    • Preview (Mac OS X; mas não funcionou em 2018/2019): "You can open the .pdf file using Preview, and do a print as file, as a new .pdf file. And you should get the fonts."
    • É possível converter todas as fontes de um PDF para embedded usando o comando abaixo no linux: (requer o pacote ghostscript, funciona também no Windows usando cygwin ou uma máquina virtual)
gs -q -dNOPAUSE -dBATCH -dPDFSETTINGS=/prepress -sDEVICE=pdfwrite -sOutputFile=output.pdf input.pdf

BibTeX

  • Sugestão prática: usem o (Bibtex Normalizer) para auxiliar na construção adequada de seu arquivo .bib

Um arquivo BibTeX organizado é fundamental! Normalmente, copiamos a entrada BibTeX de uma biblioteca digital (exemplo: DBLP). No entanto, cada biblioteca tem seu padrão próprio de formatação das referências (e alguns desses padrões são bem estranhos e feios). Então se você simplesmente copiar esses arquivos, sem nenhuma edição e padronização, o resultado final é um "mosaico"de referências sem padrão único, com cada referência formatada de um jeito.

O recomendável então é "padronizar" manualmente todas as referências BibTeX, conforme as recomendações abaixo:

  • Conferências são armazenadas em registros do tipo @inproceedings; Artigos de journal em registros @article.
  • Nomes de autores: (a) checar se primeiro nome e depois sobrenome em todos os autores (isto é, ordem certa); (b) checar se primeira letra dos nomes maiúscula; (c) checar se nomes são ligados por "and".
  • Título do paper: (a) primeira letra maiúscula e demais minúsculas; (c) abreviações e nomes próprios sempre entre chaves, ex: {API}, {IDE}, {Java} => caso contrário, vai aparecer em minúsculo.
  • Formato para nomes de conferências: [number]th [conference name] ([abbreviation]). Example: 26th Automated Software Engeneering Conference (ASE). Veja que todas as primeiras letras em maiúsculo; sigla em maiúsculo.
  • Não usar "Proceedings of" em nomes de conferências; seguir estritamente o padrão acima e começar com o número da edição da conferência.
  • Não use abreviações em nomes de conferências ou journals. Exemplo: Int. Conference on Soft. Engeneering => International Conference on Software Engeneering.
  • Toda referência obrigatoriamente tem que ter páginas inicial e final (campo pages) e ano (campo year).
  • No caso de journal (@article), deve obrigatoriamente ter também os campos "volume" e "number".
  • Nunca coloque nomes de cidades, países, ISBN, etc.
  • Em livros, simplifique o nome da editora. Exemplo: Addison Wesley Inc => Addison Wesley.

Importante:

  • Entradas Bibtex prontas e formatadas para nossas publicações estão disponíveis na página do ASERG. Basta copiar e colar.
  • É sempre bom iniciar um arquivo BibTeX logo nos primeiros passos e dias do trabalho; para não deixar para organizar isso na véspera da defesa ou submissão de um paper.

Referências

  • Apenas citar artigos de conferências e journals de qualidade, isto é: **Conferências: ICSE, FSE, ASE, ICSM(E), MSR, WCRE, CSMR, SANER, AOSD/Modularity, ICPC, OOPSLA, ECOOP
  • Journals: IEEE TSE, IEEE Software, ACM TOSEM, SPE, JSS, ESEM e IST.
  • Citações fora das conferências e journals acima tem que ter um motivo muito forte.
  • Sempre que possível, citar nossos trabalhos, claro que se eles forem relacionados e sem exageros. Via de regra, todo trabalho do grupo deve citar pelo menos um outro trabalho nosso.
  • Instead of "Reference [1] shows" or "[1] shows," use "Smith [1] showed" or "Smith and Jones [1] showed" or "Smith et al. [1] showed" (if more than two authors).
  • "et al." is used for papers with more than two authors, so it is "Smith et al. [1] show" not "shows".

SANDALO: FAVOR EXPLICAR CITEP e CITE.

  • Para balancear tamanho das colunas da última página: \usepackage{balance}

E depois (antes de começarem as referências):

\balance

\bibliographystyle{...}

Agradecimentos

  • Em todo o paper, acrescentar uma seção de agradecimentos antes de referências:
\section*{Acknowledgments}

This research is supported by grants from FAPEMIG, CAPES, and CNPq.
  • Isso é uma exigência das agências de fomento.
  • FAPEMIG e CNPq são obrigatórios, pois sempre temos projetos lá.
  • CAPES apenas se a bolsa do aluno for da CAPES ou no caso de algum projeto de cooperação internacional, como o STIC-AmSud.

Checklist para Submissão de Papers

Tarefas que devem ser feitas antes da submissão:

  • Converter para rtf (veja http://online2pdf.com/pdf2rtf) e depois usar o corretor do Word. O corretor do word é bom porque ele pega tanto erros ortográficos, com alguns erros gramaticais (sempre tem algum pequeno erro que passa despercebido).
  • Verificar i.e.,~
  • Verificar e.g.,~
  • Verificar o posicionamento das figuras e tabelas.
  • Verificar e remover viúvas e linhas órfãs (principalmente as mais "feias").

Miscelânea

  • Contar número de palavras em um paper: preferível contar no pdf e não no latex (para não contar os comandos de formatação latex). Para isso: Acrobat Reader -> Arquivo -> Salvar Como -> Selecionar formato texto. Feito isso, número de palavras pode ser contato em qualquer editor.

Clone this wiki locally