Write good papers - Speaker Deck

Slide 1

Slide 1 text

Write good papers Daniel Lemire, Ph.D. Professor of Computer Science University of Quebec (TELUQ) http://lemire.me/en/ blog: http://lemire.me/blog/ Daniel Lemire, Ph.D. Write good papers

Slide 2

Slide 2 text

Publish or perish Yes, if you don’t publish, you perish. We think by writing. We think well by writing well. More papers ⇒ more visibility. Good papers build your reputation, over time. Bad papers harm your reputation. Daniel Lemire, Ph.D. Write good papers

Slide 3

Slide 3 text

What should you write about? Must be a lasting reference (be ambitious!). Can you say something unexpected? Can you deﬁne new problems? Answer new questions? Daniel Lemire, Ph.D. Write good papers

Slide 4

Slide 4 text

How to be productive? 1 Come up with hypothesis. 2 Research it. 3 Collect data. 4 Write paper. 5 Submit it quickly to a journal. 6 Become famous! 7 . . . Daniel Lemire, Ph.D. Write good papers

Slide 5

Slide 5 text

How to be productive? 1 Come up with hypothesis. 2 Research it. 3 Collect data. 4 Write paper. 5 Submit it quickly to a journal. 6 Become famous! 7 NO! Not how it is done! Daniel Lemire, Ph.D. Write good papers

Slide 6

Slide 6 text

How to be productive? (For real this time) Come up with general topic. Read everything about it. Write about what you learn. Ask new questions. Write them up. Seek answers in the literature. Ask your peers. Eventually, you will answer new questions: keep writing it up. Have diﬀerent projects, at various stages: emergent, half done, almost done, in press. Start writing the papers before the research is completed. Take your time. Revise your writing continuously. Daniel Lemire, Ph.D. Write good papers

Slide 7

Slide 7 text

Productivity myths Time spent in front of your keyboard is critical. (Wrong!) To write a lot, focus on writing all the time. (Wrong!) Networking hurts your writing productivity. (Wrong!) Daniel Lemire, Ph.D. Write good papers

Slide 8

Slide 8 text

Productivity truths Lots of highly productive scholars have busy schedules. They do not write all the time. They have lots of relevant social interactions. They often carry on many projects at the same time. Daniel Lemire, Ph.D. Write good papers

Slide 9

Slide 9 text

How much time writing? Write daily. No need to write 10 hours a day. Two hours a day is enough to be highly proliﬁc. Daniel Lemire, Ph.D. Write good papers

Slide 10

Slide 10 text

It is all about energy! You have plenty of time! Yes, you do. But you may not have enough energy and insights to fully occupy your time with great work. Work on maximizing your energy levels and new insights. Daniel Lemire, Ph.D. Write good papers

Slide 11

Slide 11 text

To write well Work over months or years! Write 1,000,000 words. Publish the best 1,000 words. Daniel Lemire, Ph.D. Write good papers

Slide 12

Slide 12 text

Don’t be shy: use good tools If you must use MS Oﬃce: learn to use it properly. Use a spell checker. Just do it. (e.g., aspell) Learn L A TEX and BibTeX if you do a lot of math. Use version control (subversion, git). Use grammar and style checkers: style-check.rb, lacheck. Daniel Lemire, Ph.D. Write good papers

Slide 13

Slide 13 text

Things to avoid Do not use negations. Avoid the future tense (the word ”will” in English) to refer to something coming up next in the document. Avoid temporal words such as “now” or “next”. Avoid referring to other content with “below” or “above”. Most adverbs—such as ”very”—are useless in a research paper. Keep your emotions in check: the reader may not care for your surprise, your pleasure or your sadness. Use parentheses and footnotes sparingly. Daniel Lemire, Ph.D. Write good papers

Slide 14

Slide 14 text

Good papers are easy to skim Meaningful section headers (Avoid: “theory”, Prefer: “A proof that test A is valid”) Lists, bullet points, enumerations. Simple—yet beautiful—ﬁgures. Daniel Lemire, Ph.D. Write good papers

Slide 15

Slide 15 text

En dash, em dash Avoid: “pp. 4-14.” Use: “pp. 4–14.” (en dash is longer than hyphen) Avoid: “For our experiments, we used the blue ribbon, found under the table, to kill John.” Prefer: “For our experiments, we used the blue ribbon—found under the table—to kill John.” (em dash is a long hyphen) Daniel Lemire, Ph.D. Write good papers

Slide 16

Slide 16 text

Acronyms Avoid UA (useless acronyms) DUAT: Do not use acronyms in titles. DUAA: Do not use acronyms in abstracts. Deﬁned once the ﬁrst time you encounter it (“The Nuclear Terminator—henceforth NT—blew up.”) Use sparingly. Daniel Lemire, Ph.D. Write good papers

Slide 17

Slide 17 text

Be consistent Don’t use github, GitHub and Github in the same document. Don’t use “dataset” and “data set” in the same document. Daniel Lemire, Ph.D. Write good papers

Slide 18

Slide 18 text

Be consistent (2) Do: “Fig. 5 is below Fig. 6 and to the right of Fig. 4.” Do: “Figure 5 is below Figure 6 and to the right of Figure 4.” Avoid: “Fig. 5 is below ﬁg6 and to the right of Figure 4.” Daniel Lemire, Ph.D. Write good papers

Slide 19

Slide 19 text

Use spaces when appropriate It is “Head Mounted Display (HMD)” not “Head Mounted Display(HMD)”. It is “apple, orange” not “apple,orange”. Daniel Lemire, Ph.D. Write good papers

Slide 20

Slide 20 text

Learn about unbreakable spaces Unbreakable space: “p. 4” Unbreakable space: “We ate 4 pies.” Unbreakable space: “The index was at location 55552.” In L A TEX, write “p. 4”. In Microsoft Word, it is . Daniel Lemire, Ph.D. Write good papers

Slide 21

Slide 21 text

Learn about signiﬁcant digits Do not: “1012.12 ms”. Do: “1 s”. Daniel Lemire, Ph.D. Write good papers

Slide 22

Slide 22 text

Report your error margin If you report “1 s”, would it be “1 s” again if you reran the experiment? Always gather many numbers. Then report your error margin (pick one: percentage, standard variation, statistical test). Daniel Lemire, Ph.D. Write good papers

Slide 23

Slide 23 text

Be precise Avoid: “Method A is much better than method B.” Do: “Method A is 60% faster than method B.” Daniel Lemire, Ph.D. Write good papers

Slide 24

Slide 24 text

Be precise (2) Avoid : “The speed of test A depends on X.” Do: “Test A is faster when X is larger.” Daniel Lemire, Ph.D. Write good papers

Slide 25

Slide 25 text

Be precise (3) Avoid: “It was shown that test A is faster.” Do: “We showed that test A was faster.” Daniel Lemire, Ph.D. Write good papers

Slide 26

Slide 26 text

Keep It Simple Employ uncomplicated terms. Use simple words. “digging device”→ shovel. Use short sentences—no more than 15 words. Daniel Lemire, Ph.D. Write good papers

Slide 27

Slide 27 text

Be assertive without lying Avoid: “Algorithm A might be the best approach.” Do: “Algorithm A is fastest in all our tests.” Daniel Lemire, Ph.D. Write good papers

Slide 28

Slide 28 text

Prefer the present tense Avoid: “We observed a trend in our data.” Avoid: “We will observe a trend in our data.” Do: “We observe a trend in our data.” Daniel Lemire, Ph.D. Write good papers

Slide 29

Slide 29 text

Use strong verbs Avoid: “We made use of categorization.” Do: “We categorized.” Daniel Lemire, Ph.D. Write good papers

Slide 30

Slide 30 text

Be impactful Avoid: “IBM Cognos is a tool by IBM.” Avoid: “We shall shortly present our motivation.” Each of your sentence should reward us with insights. Daniel Lemire, Ph.D. Write good papers

Slide 31

Slide 31 text

How to write mathematics Variables are in italics: ax = b, Nouns or named functions are not: sin2 x = Ftiming. Be consistent. Use a table of notation if you must. Daniel Lemire, Ph.D. Write good papers

Slide 32

Slide 32 text

Begin sentences in English Avoid: “Ω is larger than one” Do: “The parameter Ω is larger than one.” Daniel Lemire, Ph.D. Write good papers

Slide 33

Slide 33 text

Overdoing mathematics makes you unreadable Plain English is better! Avoid: “We have i xi = 1.” Do: “The sum of the parameters is one: i xi = 1.” Daniel Lemire, Ph.D. Write good papers

Slide 34

Slide 34 text

Mathematics is part of the language Avoid: We have the following result. F = ma Is F = ma part of the sentence, or a sentence on its own? Daniel Lemire, Ph.D. Write good papers

Slide 35

Slide 35 text

Mathematics is part of the language (2) Do: We have the following result: F = ma. The equation is part of the sentence! Daniel Lemire, Ph.D. Write good papers

Slide 36

Slide 36 text

Figures All figures must be numbered and captioned. All figures must be referenced in the text. Caption usually goes underneath. (Table captions often go above.) Code samples of more than 3 lines should appear in figures or the equivalent, not in main text. Daniel Lemire, Ph.D. Write good papers

Slide 37

Slide 37 text

Figures and bitmaps Write good papers How? No bitmap (JPEG, PNG, GIF). Fonts must be large enough. Daniel Lemire, Ph.D. Write good papers

Slide 38

Slide 38 text

Figures: use good tools Learn about Vector Graphics: http://en.wikipedia.org/wiki/Vector_graphics. Learn about TikZ: http://www.texample.net/tikz/. Learn about Gnuplot: http://www.gnuplot.info/. Learn about matplotlib: matplotlib. Ask around! Daniel Lemire, Ph.D. Write good papers

Slide 39

Slide 39 text

Figures with Excel When using Excel: Avoid the defaults. Get rid of black border. Get rid of the silly key on the right. If you can’t use Excel properly, do not use it. Daniel Lemire, Ph.D. Write good papers

Slide 40

Slide 40 text

Should you use color? Absolutely! Most people read your papers in PDF. But it must still be readable in black and white (use dark colors). Daniel Lemire, Ph.D. Write good papers

Slide 41

Slide 41 text

Should you use hyperlinks? Absolutely! But do you need to color your hyperlinks in blue? Probably not. Daniel Lemire, Ph.D. Write good papers

Slide 42

Slide 42 text

Thou shall not label needlessly Equations are numbered only as needed. If you reference an equation, number it. Avoid unused numbers. Tables, ﬁgures, references must be referenced in the main text Daniel Lemire, Ph.D. Write good papers

Slide 43

Slide 43 text

What’s a good title Must be precise. Must be sexy and compelling. No acronym. Avoid : “On the problem of ﬁnding the derivative of sin x” Prefer: “The derivative of sin x is cos x” Daniel Lemire, Ph.D. Write good papers

Slide 44

Slide 44 text

What’s an abstract? First sentence is key: avoid rambling. Sexy: why must I read this paper absolutely? The strong points must be there. (Sometimes, people won’t read your paper.) Self-contained: no reference, no hyperlink, no image. Daniel Lemire, Ph.D. Write good papers

Slide 45

Slide 45 text

Kent Beck recipe for a good 4-sentence abstract State the problem. Why is it interesting? What did you achieve? What follows from your work? Daniel Lemire, Ph.D. Write good papers

Slide 46

Slide 46 text

Introduction Start with your motivation. Put your work in a context. How is this paper diﬀerent or similar to other work? Present the main deﬁnitions. What question are you asking? List your contributions and answers explicitly. Not a long description of how the paper is organized. Daniel Lemire, Ph.D. Write good papers

Slide 47

Slide 47 text

Theory Present examples and motivation. Then present the formalism. Don’t include too many details (use appendices if you must). Avoid unmotivated results. Communicate diﬃcult ideas with ﬁgures. Daniel Lemire, Ph.D. Write good papers

Slide 48

Slide 48 text

Experiments and discussions You need to confront your ideas with the real-world. Even theory papers should have simulations, applications or examples. Avoid pure abstract nonsensical theory. Yet experiments are no substitute for theory. Compare with the best results from your competitors. Use examples to explain your results. Daniel Lemire, Ph.D. Write good papers

Slide 49

Slide 49 text

Make your work reproducible Describe fully your methodology and setup: be reproducible. Given only your paper. . . Someone should be able to reproduce all your numbers. I am serious. Avoid secret data. Avoid secret recipes. Avoid secret software. Daniel Lemire, Ph.D. Write good papers

Slide 50

Slide 50 text

Be forthcoming with the limitations of your work Point out all obvious ﬂaws in your approach. Point out all non-obvious ﬂaws in your approach. If someone uses your work, what are they likely to struggle with? Daniel Lemire, Ph.D. Write good papers

Slide 51

Slide 51 text

Good Experiments in Computer Science Run software that’s fully described on fully described hardware. Use varied data, to show strength and weakness of your approach. Provide a complete analysis so we can understand your results. Daniel Lemire, Ph.D. Write good papers

Slide 52

Slide 52 text

Write a good conclusion Recall the strong point. Address future work. Avoid introducing new diﬃcult ideas this late. Daniel Lemire, Ph.D. Write good papers

Slide 53

Slide 53 text

The “acknowledgements” section Funding agencies! Collaborators and reviewers. Helpful discussions. Be generous! Daniel Lemire, Ph.D. Write good papers

Slide 54

Slide 54 text

References Use software to ensure correct formatting (EndNote, BibTeX). Google Scholar, IEEE, Springer, ACM, . . . can export the data in correct format. Be consistent throughout. All references must be cited in the main text! Daniel Lemire, Ph.D. Write good papers

Slide 55

Slide 55 text

How to cite? Avoid: “[2] proved that X = B.” Do: “John et al. [2] proved that X = B.” Avoid: “In (Lemire, 2008), we proved that X = B” Do: “We proved that X = B (Lemire, 2008).” Do: “Lemire (2008) proved that X = B.” Daniel Lemire, Ph.D. Write good papers

Slide 56

Slide 56 text

Who should you cite? Papers you have used. Papers you might have used. Papers citing the papers you have used. All of your competitors. People like to be cited. Be generous! Generous reference sections are also useful to readers (to identify all related work). Always cite at least one paper by Daniel Lemire. Daniel Lemire, Ph.D. Write good papers

Slide 57

Slide 57 text

Self-plagiarism Should you cite your own related work? Absolutely! Otherwise, you are guilty of self-plagiarism. Daniel Lemire, Ph.D. Write good papers

Slide 58

Slide 58 text

Why an appendix? Short pieces of code. Extra results. Boring details. If you have too much, write a technical report. Daniel Lemire, Ph.D. Write good papers

Slide 59

Slide 59 text

The technical report You have 20 pages, but they will only accept 5 pages? It may take years for your paper to appear, but you need to publish it now? Write the paper, and post it online. Perelman solved the Poincar´ e conjecture with unreviewed arXiv papers (http://www.arxiv.org). Daniel Lemire, Ph.D. Write good papers

Slide 60

Slide 60 text

Why are these slides in English? You should write in English (duh!): The best journals and conferences are in English. English journals and conferences are more widely read and indexed. Most papers are in English, and they mostly cite English papers. (Not all of your work needs to be in English.) Daniel Lemire, Ph.D. Write good papers

Slide 61

Slide 61 text

Hint! Try reading your paper out loud: Are you boring? Do you jump topic? Are you confusing? Daniel Lemire, Ph.D. Write good papers

Slide 62

Slide 62 text

Further reading See my blog at http://lemire.me/blog/ under “write good papers.” Sylvia, How to Write a Lot: A Practical Guide to Productive Academic Writing, 2007. ($15 at Amazon) Daniel Lemire, Ph.D. Write good papers