Tuesday, January 16, 2007

Checklist before paper submission

In an ideal world, a researcher would not have to worry about formatting mistakes. In the real world, we have to handle much more than just formatting before we can send an article for reviewing or publication. Keeping track of all the things to check is a hassle, so I decided to make a list to go through before submission. If nothing else, the list will alleviate the uncomfortable feeling that an obvious blunder that I missed will catch the eyes of the reviewer.

- spellcheck
- search ? and []. They signify errors or missing references. Since you know that you will be searching for ?, you may put a ? (or any other special character) in places where you want to add something later or if you are unsure of some detail.
- draw a tree showing the hierarchy of sections, subsections, and subsubsections, and see if it is what you intended it to be. Sometimes, two topics of similar importance, which should be at the same level in the hierarchy mistakenly form parent-child pairs.
-check the latex output for errors and warnings.
- search \ref{ and replace with ~\ref{ for sections, appendices, figures etc.
- use consistent and correct hyphens eg. use "ad hoc", NOT ad-hoc, NOT a mix of the two
- read paper and cite appropriate references wherever making claims that need to be supported
- try to number equation arrays consistently either in 1st or in last line (unless you have reason to number all lines)
- punctuation before an equation and at the end of each equation should be consistent and correct
- use consistent format (including font for all figures)
- maintain a consistent format for matlab plots. I stick to 16 by 12 cm, fontsize 12, stretch axes to fill figure (in figure options). It produces easy to read figures in 2 column format.
- check cross-referencing of equations (whether you are referring to the correct equation)
- check that the bibliography references are all consistently punctuated and named. eg. don't let one reference say 'ITW', and another 'Inform. Th. Workshop'. To save space, use the abbreviations for journals recommended by IEEE
- check all abbreviations to see that they have been defined ONCE and only the FIRST time they occur in the text (not in the abstract).
- after the last major change, spellcheck and read entire paper once before submitting.

Do let me know if you can think of something else to add to this list. I will be grateful :)

1 comment:

Anonymous said...

tor paper writing guide porlam! useful..I also do the ? and [] searches. Good to see these detailed.
Sudipta Basak.