The beginner’s checklist for avoiding writing blunders – I

You have done a great piece of research; designed the perfect experiment or built the perfect learning model, the results are promising and it is time to submit a paper. But wait…, only two days left before the conference deadline and you find it is pretty boring/tiresome to write things. Sounds familiar?

Many early research students do not realise the importance of the writing element in research until they start writing their first paper or worst until they see their first set of reviews. In some cases, I am surprised by the amount of typos and basic writing errors I see in papers I review. In this post I try to provide a checklist for early research students to ensure that their first serious research submission, be it a master’s thesis, conference paper, or a journal paper, is free of writing blunders. By looking at the list, one could argue that these are very obvious and trivial errors. Yet, you will be surprised to see how frequent they are, especially among the writings of early stage research students.

This is possibly the first of a series of posts, in which I plan to cover several academic writing related topics.

1) Check spelling mistakes: Use the in-built spell checker of your text editor to check spelling errors. Grammatical errors are hard to catch. I will discuss this in a seperate post.

2) Check the incomplete citations (??): Incomplete citations can happen if you keep a citation placeholder (e.g. \cite{} ) but forget to fill it or add some new citations to the bib file but forget to compile it. Once you generate the PDF do a search for ??s to avoid this ugly mistake. Same can happen with the latex \ref{} command for figures and tables.

3) Figures and tables: It is good to have figures and tables in research papers. They summarize results and can provide a quick overview to the readers.

  • Make sure all the figures and tables are referred in the text (In the order they appear)
  • All tables and figures must have captions
  • Figures axes must have titles and the units have to be clearly mentioned

4) Space errors: Quick writing can insert space errors. Many of them can’t be captured by searching in PDF readers and requires careful proofreading.

  • Extra space at the end of a sentence (Example: The simulation results showed that our hypothesis was correct .)
  • No space when starting a new sentence. (Example: The simulation results showed that our hypothesis was correct.However, …..)
  • No space before a reference (Example: Smith et al.[10] showed that a deep model ….)

5) Correct use of commonly used abbreviations/notations/symbols

  • Smith et al. [10] (et al. with a period is the correct usage)
  • e.g. is the correct usage of “for example” (similarly i.e.)
  • If a sentence ends with a footnote symbol, the period comes before the footnote not after. Same for comma as well. (Example: Alexa lists the top-100 websites in the internet.1