sexta-feira, 15 de maio de 2009

Checklist

Ao escrever um artigo, nem sempre o problema está na gramática ou falta de familiaridade com a língua inglesa. Às vezes o texto pode ser fortemente melhorado realizando a seguinte checklist, recomendada pelo livro Writing for Computer Science, de Justin Zobel, 2nd Edition, Springer, 2004.

  • Os títulos das seções e do próprio artigo são consistentes com o conteúdo?
  • Todos os termos usados foram definidos?
  • O estilo usado em todas as definições é consistente? Por exemplo, todos os novos termos foram introduzidos em itálico ou somente alguns?
  • A terminologia foi usada de forma consistente? Por exemplo, a rede local ora é referenciada como "rede de dados" e ora como "rede local"?
  • Todas as abreviaturas e acrônimos foram explicitadas na primeira vez em que foram utilizadas? Lembre-se que o Abstract não deve ser considerado como primeira ocorrência.
  • Existem abreviaturas e acrônimos explicados mais de uma vez ao longo do texto?
  • Existem abreviaturas utilizadas menos de quatro vezes? Se for o caso, elas podem ser eliminadas?
  • Os títulos são capitalizados da mesma forma?
  • A ortografia é consistente? Por exemplo, a convenção do inglês britânico é misturada com a do inglês amaericano?
  • Os tempos verbais são usados corretamente?
  • Parênteses, colchetes, chaves, aspas e apóstrofes abertos também são fechados?
  • As aspas e apóstrofes são todas do mesmo estilo? Por exemplo, aspas curvas (“ ”) são mescladas com aspas retas (")?
  • Todas as referências bibliográficas, figuras, tabelas, algoritmos e outros elementos gráficos são discutidos ao longo do texto, de maneira consistente?
  • Os estilos negrito e itálico são usados de maneira lógica?
  • Existem palvaras hifenizadas em alguns lugares e em outros não? Por exemplo, "fim a fim" e "fim-a-fim" convivem ambas no mesmo texto?
  • As unidades de medida são usadas consistentemente? Por exemplo, megabyte foi abreviado como "Mb" em alguns lugares e como "Mbyte" em outros?
  • Todos os valores referentes a uma mesma grandeza são representados com a mesma precisão (número de casas decimais)?
  • Os gráficos são todos do mesmo tamanho? As unidades dos eixos são fornecidas?
  • As tabelas possuem o mesmo formato? As unidades são fornecidas?
  • Foi usado o mesmo estilo em todos os algoritmos? As variáveis são nomeadas e grafadas de forma consistente? Todos os comandos possuem uma mesma sintaxe? A indentação é consistente?
  • As referências bibliográficas foram formatas consistentemente? Os títulos dos trabalhos são colocados ora em itálico, ora entre aspas, ou outro estilo? A capitalização é consistente? O estilo de abreviação dos nomes dos autores é consistente? Os mesmos campos são fornecidos para todas as referências de um mesmo tipo?
  • A formatação do texto em geral é consistente? Existem parágrafos com alinhamentos diferentes sem motivo? Existem parágrafos indentados e outros não? Espaçamento entre linhas é consistente?

Nenhum comentário:

Postar um comentário