SlideShare a Scribd company logo
1 of 52
How to write a
 great research paper

     Simon Peyton Jones
Microsoft Research, Cambridge
Writing papers is a skill
                Many papers are badly written
                Good writing is a skill you can learn
                It’s a skill that is worth learning:
                    You will get more brownie points (more
                     papers accepted etc)
                     Your ideas will have more impact
importance
Increasing




                 

                    You will have better ideas
Writing papers: model 1

Idea   Do research   Write paper
Writing papers: model 2
       Idea     Do research     Write paper



       Idea     Write paper     Do research


   Forces us to be clear, focused
   Crystallises what we don’t understand
   Opens the way to dialogue with others:
    reality check, critique, and collaboration
Do not be intimidated
Fallacy   You need to have a fantastic idea before
          you can write a paper. (Everyone else
          seems to.)


               Write a paper,
            and give a talk, about

              any idea,
  no matter how weedy and insignificant it
             may seem to you
Do not be intimidated

     Write a paper, and give a talk, about any
     idea, no matter how insignificant it may
                   seem to you

   Writing the paper is how you develop the
    idea in the first place
   It usually turns out to be more interesting
    and challenging that it seemed at first
The purpose of your paper
Why
    bother?

Fallacy                Good papers and
we write papers and
give talks mainly to
                         talks are a
impress others, gain
recognition, and get
                        fundamental
promoted                   part of
                          research
                         excellence
Papers communicate ideas
   Your goal: to infect the mind of your
    reader with your idea, like a virus
   Papers are far more durable than
    programs (think Mozart)


    The greatest ideas are (literally)
     worthless if you keep them to
                yourself
Idea
         The Idea            A re-usable insight,
                             useful to the reader
   Figure out what your idea is
   Make certain that the reader is in no
    doubt what the idea is. Be 100% explicit:
       “The main idea of this paper is....”
       “In this section we present the main
        contributions of the paper.”
   Many papers contain good ideas, but do
    not distil what they are.
One ping
   Your paper should have just one “ping”:
    one clear, sharp idea
   Read your paper again: can you hear the
    “ping”?
   You may not know exactly what the ping
    is when you start writing; but you must
    know when you finish
   If you have lots of ideas, write lots of
    papers
                       Thanks to Joe Touch for “one ping”
The purpose of your paper is not...

  To describe
  the WizWoz
     system
 Your reader does not have a WizWoz
 She is primarily interested in re-usable
  brain-stuff, not executable artefacts
Your narrative flow             I wish I
                                    knew how
                                     to solve
   Here is a problem                  that!

   It’s an interesting problem
   It’s an unsolved problem      I see how
                                     that
   Here is my idea                 works.
                                  Ingenious!
   My idea works (details, data)
   Here’s how my idea compares to other
    people’s approaches
Structure (conference paper)
   Title (1000 readers)
   Abstract (4 sentences, 100 readers)
   Introduction (1 page, 100 readers)
   The problem (1 page, 10 readers)
   My idea (2 pages, 10 readers)
   The details (5 pages, 3 readers)
   Related work (1-2 pages, 10 readers)
   Conclusions and further work (0.5 pages)
The abstract
        I usually write the abstract last
        Used by program committee members
         to decide which papers to read
        Four sentences [Kent Beck]
    1.    State the problem
    2.    Say why it’s an interesting problem
    3.    Say what your solution achieves
    4.    Say what follows from your solution
Example

1.   Many papers are badly written and
     hard to understand
2.   This is a pity, because their good ideas
     may go unappreciated
3.   Following simple guidelines can
     dramatically improve the quality of
     your papers
4.   Your work will be used more, and the
     feedback you get from others will in
     turn improve your research
Structure
   Abstract (4 sentences)
   Introduction (1 page)
   The problem (1 page)
   My idea (2 pages)
   The details (5 pages)
   Related work (1-2 pages)
   Conclusions and further work (0.5 pages)
The introduction (1 page)
1.  Describe the problem
2. State your contributions

...and that is all

ONE PAGE!
Describe the problem

                         Use an
                        example
                           to
                       introduce
                          the
                        problem
State your contributions
   Write the list of contributions first
   The list of contributions drives the
    entire paper: the paper substantiates
    the claims you have made
   Reader thinks “gosh, if they can really
    deliver this, that’s be exciting; I’d
    better read on”
State your contributions

                          Bulleted list
                               of
                         contributions




                       Do not leave the
                     reader to guess what
                    your contributions are!
Contributions should be refutable

           NO!                               YES!
We describe the WizWoz       We give the syntax and semantics of
system. It is really cool.   a language that supports concurrent
                             processes (Section 3). Its innovative
                             features are...
We study its properties      We prove that the type system is
                             sound, and that type checking is
                             decidable (Section 4)
We have used WizWoz in       We have built a GUI toolkit in
practice                     WizWoz, and used it to implement a
                             text editor (Section 5). The result is
                             half the length of the Java version.
No “rest of this paper is...”
   Not:   “The rest of this paper is structured as
           follows. Section 2 introduces the problem.
           Section 3 ... Finally, Section 8 concludes”.


   Instead, use forward references from
    the narrative in the introduction.
    The introduction (including the
    contributions) should survey the whole
    paper, and therefore forward reference
    every important part.
Structure
   Abstract (4 sentences)
   Introduction (1 page)
   Related work
   The problem (1 page)
   My idea (2 pages)
   The details (5 pages)
   Related work (1-2 pages)
   Conclusions and further work (0.5 pages)
No related work yet!



                           Related
                            work

Your reader                                       Your idea
  We adopt the notion of transaction from Brown [1], as modified
  for distributed systems by White [2], using the four-phase
  interpolation algorithm of Green [3]. Our work differs from
  White in our advanced revocation protocol, which deals with the
  case of priority inversion as described by Yellow [4].
No related work yet
                                       I feel
                                       stupid
   Problem 1: the reader knows
    nothing about the problem yet;
    so your (carefully trimmed)
    description of various technical
    tradeoffs is absolutely
    incomprehensible
   Problem 2: describing
    alternative approaches gets        I feel
    between the reader and your        tired
    idea
Structure
   Abstract (4 sentences)
   Introduction (1 page)
   The problem (1 page)
   My idea (2 pages)
   The details (5 pages)
   Related work (1-2 pages)
   Conclusions and further work (0.5 pages)
Presenting the idea
3. The idea
Consider a bifircuated semi-lattice D, over a
hyper-modulated signature S. Suppose pi is an
element of D. Then we know for every such p i
there is an epi-modulus j, such that pj < pi.
 Sounds impressive...but
 Sends readers to sleep
 In a paper you MUST provide the details,
  but FIRST convey the idea
Presenting the idea
   Explain it as if you were speaking to
    someone using a whiteboard
   Conveying the intuition is primary, not
    secondary
   Once your reader has the intuition, she
    can follow the details (but not vice
    versa)
   Even if she skips the details, she still
    takes away something valuable
Putting the reader first
   Do not recapitulate your personal
    journey of discovery. This route may
    be soaked with your blood, but that is
    not interesting to the reader.

   Instead, choose the most direct route
    to the idea.
The payload of your paper

 Introduce the problem, and
      your idea, using


   EXAMPLES
  and only then present the
        general case
The Simon PJ
Using examples   question: is there
                  any typewriter
                       font?




                       Example
                        right
                        away
The details: evidence
   Your introduction makes claims
   The body of the paper provides
    evidence to support each claim
   Check each claim in the introduction,
    identify the evidence, and forward-
    reference it from the claim
   Evidence can be: analysis and
    comparison, theorems, measurements,
    case studies
Structure
   Abstract (4 sentences)
   Introduction (1 page)
   The problem (1 page)
   My idea (2 pages)
   The details (5 pages)
   Related work (1-2 pages)
   Conclusions and further work (0.5 pages)
Related work

Fallacy   To make my work look good, I
          have to make other people’s
          work look bad
The truth: credit is not like money

  Giving credit to others does not
  diminish the credit you get from
             your paper
 Warmly acknowledge people who have helped
  you
 Be generous to the competition. “In his
  inspiring paper [Foo98] Foogle shows.... We
  develop his foundation in the following ways...”
 Acknowledge weaknesses in your approach
Credit is not like money

    Failing to give credit to others
           can kill your paper


If you imply that an idea is yours, and the
referee knows it is not, then either
  You don’t know that it’s an old idea (bad)
  You do know, but are pretending it’s yours
   (very bad)
Structure
   Abstract (4 sentences)
   Introduction (1 page)
   The problem (1 page)
   My idea (2 pages)
   The details (5 pages)
   Related work (1-2 pages)
   Conclusions and further work (0.5 pages)
Conclusions and further work
   Be brief.
The process of writing
The process
   Start early. Very early.
       Hastily-written papers get rejected.
       Papers are like wine: they need time to
        mature
   Collaborate
   Use CVS to support collaboration
Getting help
     Get your paper read by as many
     friendly guinea pigs as possible
   Experts are good
   Non-experts are also very good
   Each reader can only read your paper for the
    first time once! So use them carefully
   Explain carefully what you want (“I got lost
    here” is much more important than “Jarva is
    mis-spelt”.)
Getting expert help
   A good plan: when you think you are done,
    send the draft to the competition saying
    “could you help me ensure that I describe
    your work fairly?”.
   Often they will respond with helpful
    critique (they are interested in the area)
   They are likely to be your referees anyway,
    so getting their comments or criticism up
    front is Jolly Good.
Listening to your reviewers

 Treat every review like gold dust
 Be (truly) grateful for criticism as
            well as praise

   This is really, really, really hard

                  But it’s
really, really, really, really, really, really,
        really, really, really, really
                  important
Listening to your reviewers

   Read every criticism as a positive
    suggestion for something you could
    explain more clearly
   DO NOT respond “you stupid person, I
    meant X”. Fix the paper so that X is
    apparent even to the stupidest reader.
   Thank them warmly. They have given up
    their time for you.
Language and style
Basic stuff
   Submit by the deadline
   Keep to the length restrictions
       Do not narrow the margins
       Do not use 6pt font
       On occasion, supply supporting evidence
        (e.g. experimental data, or a written-out
        proof) in an appendix
   Always use a spell checker
Visual structure
   Give strong visual structure to your
    paper using
       sections and sub-sections
       bullets
       italics
       laid-out code
   Find out how to draw pictures, and
    use them
Visual structure
Use the active voice
   The passive voice is “respectable” but it DEADENS
            your paper. Avoid it at all costs.
                                                               “We” = you
                                                                and the
         NO                                YES                   reader

  It can be seen that...              We can see that...
    34 tests were run                 We ran 34 tests
 These properties were            We wanted to retain these
   thought desirable                    properties
                                                               “We” = the
It might be thought that          You might think this would    authors
this would be a type error             be a type error

                        “You” =
                          the
                        reader
Use simple, direct language

            NO                                YES
 The object under study was
                                     The ball moved sideways
   displaced horizontally

      On an annual basis                      Yearly


   Endeavour to ascertain                    Find out


It could be considered that the
                                  The garbage collector was really
 speed of storage reclamation
                                               slow
 left something to be desired
Summary

If you remember nothing else:
 Identify your key idea

 Make your contributions explicit

 Use examples



A good starting point:
  “Advice on Research and Writing”
  http://www-2.cs.cmu.edu/afs/cs.cmu.edu/user/
                       mleone/web/how-to.html

More Related Content

Viewers also liked (15)

Chapter 1
Chapter 1Chapter 1
Chapter 1
 
Chapter 29
Chapter 29Chapter 29
Chapter 29
 
Chapter 20
Chapter 20Chapter 20
Chapter 20
 
Chapter 28
Chapter 28Chapter 28
Chapter 28
 
Chapter 6
Chapter 6Chapter 6
Chapter 6
 
Chapter 23
Chapter 23Chapter 23
Chapter 23
 
Pop quiz powerpoint
Pop quiz powerpointPop quiz powerpoint
Pop quiz powerpoint
 
Chapter 22
Chapter 22Chapter 22
Chapter 22
 
Chapter 9
Chapter 9Chapter 9
Chapter 9
 
Chapter 2
Chapter 2Chapter 2
Chapter 2
 
Value Chris Van Alsburg
Value Chris Van AlsburgValue Chris Van Alsburg
Value Chris Van Alsburg
 
Chapter 26
Chapter 26Chapter 26
Chapter 26
 
Chapter 4
Chapter 4Chapter 4
Chapter 4
 
Illustrations drawings photos and captions in thessi wrting ssnaik tnau
Illustrations drawings photos and captions in thessi wrting ssnaik tnauIllustrations drawings photos and captions in thessi wrting ssnaik tnau
Illustrations drawings photos and captions in thessi wrting ssnaik tnau
 
Illustration Module Workbook
Illustration Module WorkbookIllustration Module Workbook
Illustration Module Workbook
 

Similar to Peyton jones-writing

Write a research paper howto - good presentation
Write a research paper   howto - good presentationWrite a research paper   howto - good presentation
Write a research paper howto - good presentation
antiw
 
Writing A Paper Barcelona
Writing A Paper BarcelonaWriting A Paper Barcelona
Writing A Paper Barcelona
Weiwei Fang
 
Enc1101drafting unit2
Enc1101drafting unit2Enc1101drafting unit2
Enc1101drafting unit2
Heather Wayne
 
sourcehttpsletterpile.comwritingHow-to-write-a-Philosop.docx
sourcehttpsletterpile.comwritingHow-to-write-a-Philosop.docxsourcehttpsletterpile.comwritingHow-to-write-a-Philosop.docx
sourcehttpsletterpile.comwritingHow-to-write-a-Philosop.docx
whitneyleman54422
 

Similar to Peyton jones-writing (20)

Write a research paper howto - good presentation
Write a research paper   howto - good presentationWrite a research paper   howto - good presentation
Write a research paper howto - good presentation
 
Writing A Paper Barcelona
Writing A Paper BarcelonaWriting A Paper Barcelona
Writing A Paper Barcelona
 
20090720 writing a_paper
20090720 writing a_paper20090720 writing a_paper
20090720 writing a_paper
 
Research Paper Writing
Research Paper WritingResearch Paper Writing
Research Paper Writing
 
Lecture11 (cs212)(how towriteareserchpaper)
Lecture11 (cs212)(how towriteareserchpaper)Lecture11 (cs212)(how towriteareserchpaper)
Lecture11 (cs212)(how towriteareserchpaper)
 
How to write papers, part 1 principles
How to  write papers, part 1 principlesHow to  write papers, part 1 principles
How to write papers, part 1 principles
 
Thesis powerpoint
Thesis powerpointThesis powerpoint
Thesis powerpoint
 
jon-on reasearch.ppt
jon-on reasearch.pptjon-on reasearch.ppt
jon-on reasearch.ppt
 
D12-EWRT 1A
D12-EWRT 1AD12-EWRT 1A
D12-EWRT 1A
 
Enc1101drafting unit2
Enc1101drafting unit2Enc1101drafting unit2
Enc1101drafting unit2
 
Writing Technical Papers
Writing Technical PapersWriting Technical Papers
Writing Technical Papers
 
All about writing
All about writingAll about writing
All about writing
 
Coherence
CoherenceCoherence
Coherence
 
Lecture 3-ScientificWriting.pptx
Lecture 3-ScientificWriting.pptxLecture 3-ScientificWriting.pptx
Lecture 3-ScientificWriting.pptx
 
Research paper
Research paperResearch paper
Research paper
 
sourcehttpsletterpile.comwritingHow-to-write-a-Philosop.docx
sourcehttpsletterpile.comwritingHow-to-write-a-Philosop.docxsourcehttpsletterpile.comwritingHow-to-write-a-Philosop.docx
sourcehttpsletterpile.comwritingHow-to-write-a-Philosop.docx
 
Entering the Conversation (Week 2 2017)
Entering the Conversation (Week 2 2017)Entering the Conversation (Week 2 2017)
Entering the Conversation (Week 2 2017)
 
Ewrt 1 a class 12
Ewrt 1 a class 12Ewrt 1 a class 12
Ewrt 1 a class 12
 
Ewrt 1 a class 12
Ewrt 1 a class 12Ewrt 1 a class 12
Ewrt 1 a class 12
 
Ewrt 1 a class 6
Ewrt 1 a class 6Ewrt 1 a class 6
Ewrt 1 a class 6
 

More from kstivers1

Parts of speech jeopardy
Parts of speech jeopardyParts of speech jeopardy
Parts of speech jeopardy
kstivers1
 
Preposition power mini
Preposition power miniPreposition power mini
Preposition power mini
kstivers1
 
Verbs action
Verbs actionVerbs action
Verbs action
kstivers1
 
Adjectives and adverbs
Adjectives and adverbsAdjectives and adverbs
Adjectives and adverbs
kstivers1
 
Statement of purpose
Statement of purpose Statement of purpose
Statement of purpose
kstivers1
 
Review presentation
Review presentationReview presentation
Review presentation
kstivers1
 

More from kstivers1 (19)

Parts of speech jeopardy
Parts of speech jeopardyParts of speech jeopardy
Parts of speech jeopardy
 
Preposition power mini
Preposition power miniPreposition power mini
Preposition power mini
 
Verbs action
Verbs actionVerbs action
Verbs action
 
Adjectives and adverbs
Adjectives and adverbsAdjectives and adverbs
Adjectives and adverbs
 
Statement of purpose
Statement of purpose Statement of purpose
Statement of purpose
 
Review presentation
Review presentationReview presentation
Review presentation
 
Chapter 30
Chapter 30Chapter 30
Chapter 30
 
Chapter 29
Chapter 29Chapter 29
Chapter 29
 
Chapter 27
Chapter 27Chapter 27
Chapter 27
 
Chapter 26
Chapter 26Chapter 26
Chapter 26
 
Chapter 25
Chapter 25Chapter 25
Chapter 25
 
Chapter 24
Chapter 24Chapter 24
Chapter 24
 
Chapter 21
Chapter 21Chapter 21
Chapter 21
 
Chapter 19
Chapter 19Chapter 19
Chapter 19
 
Chapter 18
Chapter 18Chapter 18
Chapter 18
 
Chapter 17
Chapter 17Chapter 17
Chapter 17
 
Chapter 16
Chapter 16Chapter 16
Chapter 16
 
Chapter 15
Chapter 15Chapter 15
Chapter 15
 
Chapter 14
Chapter 14Chapter 14
Chapter 14
 

Recently uploaded

BASLIQ CURRENT LOOKBOOK LOOKBOOK(1) (1).pdf
BASLIQ CURRENT LOOKBOOK  LOOKBOOK(1) (1).pdfBASLIQ CURRENT LOOKBOOK  LOOKBOOK(1) (1).pdf
BASLIQ CURRENT LOOKBOOK LOOKBOOK(1) (1).pdf
SoniaTolstoy
 
Activity 01 - Artificial Culture (1).pdf
Activity 01 - Artificial Culture (1).pdfActivity 01 - Artificial Culture (1).pdf
Activity 01 - Artificial Culture (1).pdf
ciinovamais
 
Beyond the EU: DORA and NIS 2 Directive's Global Impact
Beyond the EU: DORA and NIS 2 Directive's Global ImpactBeyond the EU: DORA and NIS 2 Directive's Global Impact
Beyond the EU: DORA and NIS 2 Directive's Global Impact
PECB
 
Kisan Call Centre - To harness potential of ICT in Agriculture by answer farm...
Kisan Call Centre - To harness potential of ICT in Agriculture by answer farm...Kisan Call Centre - To harness potential of ICT in Agriculture by answer farm...
Kisan Call Centre - To harness potential of ICT in Agriculture by answer farm...
Krashi Coaching
 
Russian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in Delhi
Russian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in DelhiRussian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in Delhi
Russian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in Delhi
kauryashika82
 

Recently uploaded (20)

Paris 2024 Olympic Geographies - an activity
Paris 2024 Olympic Geographies - an activityParis 2024 Olympic Geographies - an activity
Paris 2024 Olympic Geographies - an activity
 
BASLIQ CURRENT LOOKBOOK LOOKBOOK(1) (1).pdf
BASLIQ CURRENT LOOKBOOK  LOOKBOOK(1) (1).pdfBASLIQ CURRENT LOOKBOOK  LOOKBOOK(1) (1).pdf
BASLIQ CURRENT LOOKBOOK LOOKBOOK(1) (1).pdf
 
Introduction to Nonprofit Accounting: The Basics
Introduction to Nonprofit Accounting: The BasicsIntroduction to Nonprofit Accounting: The Basics
Introduction to Nonprofit Accounting: The Basics
 
Activity 01 - Artificial Culture (1).pdf
Activity 01 - Artificial Culture (1).pdfActivity 01 - Artificial Culture (1).pdf
Activity 01 - Artificial Culture (1).pdf
 
Nutritional Needs Presentation - HLTH 104
Nutritional Needs Presentation - HLTH 104Nutritional Needs Presentation - HLTH 104
Nutritional Needs Presentation - HLTH 104
 
Beyond the EU: DORA and NIS 2 Directive's Global Impact
Beyond the EU: DORA and NIS 2 Directive's Global ImpactBeyond the EU: DORA and NIS 2 Directive's Global Impact
Beyond the EU: DORA and NIS 2 Directive's Global Impact
 
Kisan Call Centre - To harness potential of ICT in Agriculture by answer farm...
Kisan Call Centre - To harness potential of ICT in Agriculture by answer farm...Kisan Call Centre - To harness potential of ICT in Agriculture by answer farm...
Kisan Call Centre - To harness potential of ICT in Agriculture by answer farm...
 
Key note speaker Neum_Admir Softic_ENG.pdf
Key note speaker Neum_Admir Softic_ENG.pdfKey note speaker Neum_Admir Softic_ENG.pdf
Key note speaker Neum_Admir Softic_ENG.pdf
 
A Critique of the Proposed National Education Policy Reform
A Critique of the Proposed National Education Policy ReformA Critique of the Proposed National Education Policy Reform
A Critique of the Proposed National Education Policy Reform
 
Russian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in Delhi
Russian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in DelhiRussian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in Delhi
Russian Escort Service in Delhi 11k Hotel Foreigner Russian Call Girls in Delhi
 
BAG TECHNIQUE Bag technique-a tool making use of public health bag through wh...
BAG TECHNIQUE Bag technique-a tool making use of public health bag through wh...BAG TECHNIQUE Bag technique-a tool making use of public health bag through wh...
BAG TECHNIQUE Bag technique-a tool making use of public health bag through wh...
 
General AI for Medical Educators April 2024
General AI for Medical Educators April 2024General AI for Medical Educators April 2024
General AI for Medical Educators April 2024
 
APM Welcome, APM North West Network Conference, Synergies Across Sectors
APM Welcome, APM North West Network Conference, Synergies Across SectorsAPM Welcome, APM North West Network Conference, Synergies Across Sectors
APM Welcome, APM North West Network Conference, Synergies Across Sectors
 
Interactive Powerpoint_How to Master effective communication
Interactive Powerpoint_How to Master effective communicationInteractive Powerpoint_How to Master effective communication
Interactive Powerpoint_How to Master effective communication
 
Measures of Central Tendency: Mean, Median and Mode
Measures of Central Tendency: Mean, Median and ModeMeasures of Central Tendency: Mean, Median and Mode
Measures of Central Tendency: Mean, Median and Mode
 
Sports & Fitness Value Added Course FY..
Sports & Fitness Value Added Course FY..Sports & Fitness Value Added Course FY..
Sports & Fitness Value Added Course FY..
 
Sanyam Choudhary Chemistry practical.pdf
Sanyam Choudhary Chemistry practical.pdfSanyam Choudhary Chemistry practical.pdf
Sanyam Choudhary Chemistry practical.pdf
 
Call Girls in Dwarka Mor Delhi Contact Us 9654467111
Call Girls in Dwarka Mor Delhi Contact Us 9654467111Call Girls in Dwarka Mor Delhi Contact Us 9654467111
Call Girls in Dwarka Mor Delhi Contact Us 9654467111
 
Accessible design: Minimum effort, maximum impact
Accessible design: Minimum effort, maximum impactAccessible design: Minimum effort, maximum impact
Accessible design: Minimum effort, maximum impact
 
Q4-W6-Restating Informational Text Grade 3
Q4-W6-Restating Informational Text Grade 3Q4-W6-Restating Informational Text Grade 3
Q4-W6-Restating Informational Text Grade 3
 

Peyton jones-writing

  • 1. How to write a great research paper Simon Peyton Jones Microsoft Research, Cambridge
  • 2. Writing papers is a skill  Many papers are badly written  Good writing is a skill you can learn  It’s a skill that is worth learning:  You will get more brownie points (more papers accepted etc) Your ideas will have more impact importance Increasing   You will have better ideas
  • 3. Writing papers: model 1 Idea Do research Write paper
  • 4. Writing papers: model 2 Idea Do research Write paper Idea Write paper Do research  Forces us to be clear, focused  Crystallises what we don’t understand  Opens the way to dialogue with others: reality check, critique, and collaboration
  • 5. Do not be intimidated Fallacy You need to have a fantastic idea before you can write a paper. (Everyone else seems to.) Write a paper, and give a talk, about any idea, no matter how weedy and insignificant it may seem to you
  • 6. Do not be intimidated Write a paper, and give a talk, about any idea, no matter how insignificant it may seem to you  Writing the paper is how you develop the idea in the first place  It usually turns out to be more interesting and challenging that it seemed at first
  • 7. The purpose of your paper
  • 8. Why bother? Fallacy Good papers and we write papers and give talks mainly to talks are a impress others, gain recognition, and get fundamental promoted part of research excellence
  • 9. Papers communicate ideas  Your goal: to infect the mind of your reader with your idea, like a virus  Papers are far more durable than programs (think Mozart) The greatest ideas are (literally) worthless if you keep them to yourself
  • 10. Idea The Idea A re-usable insight, useful to the reader  Figure out what your idea is  Make certain that the reader is in no doubt what the idea is. Be 100% explicit:  “The main idea of this paper is....”  “In this section we present the main contributions of the paper.”  Many papers contain good ideas, but do not distil what they are.
  • 11. One ping  Your paper should have just one “ping”: one clear, sharp idea  Read your paper again: can you hear the “ping”?  You may not know exactly what the ping is when you start writing; but you must know when you finish  If you have lots of ideas, write lots of papers Thanks to Joe Touch for “one ping”
  • 12. The purpose of your paper is not... To describe the WizWoz system  Your reader does not have a WizWoz  She is primarily interested in re-usable brain-stuff, not executable artefacts
  • 13. Your narrative flow I wish I knew how to solve  Here is a problem that!  It’s an interesting problem  It’s an unsolved problem I see how that  Here is my idea works. Ingenious!  My idea works (details, data)  Here’s how my idea compares to other people’s approaches
  • 14. Structure (conference paper)  Title (1000 readers)  Abstract (4 sentences, 100 readers)  Introduction (1 page, 100 readers)  The problem (1 page, 10 readers)  My idea (2 pages, 10 readers)  The details (5 pages, 3 readers)  Related work (1-2 pages, 10 readers)  Conclusions and further work (0.5 pages)
  • 15. The abstract  I usually write the abstract last  Used by program committee members to decide which papers to read  Four sentences [Kent Beck] 1. State the problem 2. Say why it’s an interesting problem 3. Say what your solution achieves 4. Say what follows from your solution
  • 16. Example 1. Many papers are badly written and hard to understand 2. This is a pity, because their good ideas may go unappreciated 3. Following simple guidelines can dramatically improve the quality of your papers 4. Your work will be used more, and the feedback you get from others will in turn improve your research
  • 17. Structure  Abstract (4 sentences)  Introduction (1 page)  The problem (1 page)  My idea (2 pages)  The details (5 pages)  Related work (1-2 pages)  Conclusions and further work (0.5 pages)
  • 18. The introduction (1 page) 1. Describe the problem 2. State your contributions ...and that is all ONE PAGE!
  • 19. Describe the problem Use an example to introduce the problem
  • 20. State your contributions  Write the list of contributions first  The list of contributions drives the entire paper: the paper substantiates the claims you have made  Reader thinks “gosh, if they can really deliver this, that’s be exciting; I’d better read on”
  • 21. State your contributions Bulleted list of contributions Do not leave the reader to guess what your contributions are!
  • 22. Contributions should be refutable NO! YES! We describe the WizWoz We give the syntax and semantics of system. It is really cool. a language that supports concurrent processes (Section 3). Its innovative features are... We study its properties We prove that the type system is sound, and that type checking is decidable (Section 4) We have used WizWoz in We have built a GUI toolkit in practice WizWoz, and used it to implement a text editor (Section 5). The result is half the length of the Java version.
  • 23. No “rest of this paper is...”  Not: “The rest of this paper is structured as follows. Section 2 introduces the problem. Section 3 ... Finally, Section 8 concludes”.  Instead, use forward references from the narrative in the introduction. The introduction (including the contributions) should survey the whole paper, and therefore forward reference every important part.
  • 24. Structure  Abstract (4 sentences)  Introduction (1 page)  Related work  The problem (1 page)  My idea (2 pages)  The details (5 pages)  Related work (1-2 pages)  Conclusions and further work (0.5 pages)
  • 25. No related work yet! Related work Your reader Your idea We adopt the notion of transaction from Brown [1], as modified for distributed systems by White [2], using the four-phase interpolation algorithm of Green [3]. Our work differs from White in our advanced revocation protocol, which deals with the case of priority inversion as described by Yellow [4].
  • 26. No related work yet I feel stupid  Problem 1: the reader knows nothing about the problem yet; so your (carefully trimmed) description of various technical tradeoffs is absolutely incomprehensible  Problem 2: describing alternative approaches gets I feel between the reader and your tired idea
  • 27. Structure  Abstract (4 sentences)  Introduction (1 page)  The problem (1 page)  My idea (2 pages)  The details (5 pages)  Related work (1-2 pages)  Conclusions and further work (0.5 pages)
  • 28. Presenting the idea 3. The idea Consider a bifircuated semi-lattice D, over a hyper-modulated signature S. Suppose pi is an element of D. Then we know for every such p i there is an epi-modulus j, such that pj < pi.  Sounds impressive...but  Sends readers to sleep  In a paper you MUST provide the details, but FIRST convey the idea
  • 29. Presenting the idea  Explain it as if you were speaking to someone using a whiteboard  Conveying the intuition is primary, not secondary  Once your reader has the intuition, she can follow the details (but not vice versa)  Even if she skips the details, she still takes away something valuable
  • 30. Putting the reader first  Do not recapitulate your personal journey of discovery. This route may be soaked with your blood, but that is not interesting to the reader.  Instead, choose the most direct route to the idea.
  • 31. The payload of your paper Introduce the problem, and your idea, using EXAMPLES and only then present the general case
  • 32. The Simon PJ Using examples question: is there any typewriter font? Example right away
  • 33. The details: evidence  Your introduction makes claims  The body of the paper provides evidence to support each claim  Check each claim in the introduction, identify the evidence, and forward- reference it from the claim  Evidence can be: analysis and comparison, theorems, measurements, case studies
  • 34. Structure  Abstract (4 sentences)  Introduction (1 page)  The problem (1 page)  My idea (2 pages)  The details (5 pages)  Related work (1-2 pages)  Conclusions and further work (0.5 pages)
  • 35. Related work Fallacy To make my work look good, I have to make other people’s work look bad
  • 36. The truth: credit is not like money Giving credit to others does not diminish the credit you get from your paper  Warmly acknowledge people who have helped you  Be generous to the competition. “In his inspiring paper [Foo98] Foogle shows.... We develop his foundation in the following ways...”  Acknowledge weaknesses in your approach
  • 37. Credit is not like money Failing to give credit to others can kill your paper If you imply that an idea is yours, and the referee knows it is not, then either  You don’t know that it’s an old idea (bad)  You do know, but are pretending it’s yours (very bad)
  • 38. Structure  Abstract (4 sentences)  Introduction (1 page)  The problem (1 page)  My idea (2 pages)  The details (5 pages)  Related work (1-2 pages)  Conclusions and further work (0.5 pages)
  • 39. Conclusions and further work  Be brief.
  • 40. The process of writing
  • 41. The process  Start early. Very early.  Hastily-written papers get rejected.  Papers are like wine: they need time to mature  Collaborate  Use CVS to support collaboration
  • 42. Getting help Get your paper read by as many friendly guinea pigs as possible  Experts are good  Non-experts are also very good  Each reader can only read your paper for the first time once! So use them carefully  Explain carefully what you want (“I got lost here” is much more important than “Jarva is mis-spelt”.)
  • 43. Getting expert help  A good plan: when you think you are done, send the draft to the competition saying “could you help me ensure that I describe your work fairly?”.  Often they will respond with helpful critique (they are interested in the area)  They are likely to be your referees anyway, so getting their comments or criticism up front is Jolly Good.
  • 44. Listening to your reviewers Treat every review like gold dust Be (truly) grateful for criticism as well as praise This is really, really, really hard But it’s really, really, really, really, really, really, really, really, really, really important
  • 45. Listening to your reviewers  Read every criticism as a positive suggestion for something you could explain more clearly  DO NOT respond “you stupid person, I meant X”. Fix the paper so that X is apparent even to the stupidest reader.  Thank them warmly. They have given up their time for you.
  • 47. Basic stuff  Submit by the deadline  Keep to the length restrictions  Do not narrow the margins  Do not use 6pt font  On occasion, supply supporting evidence (e.g. experimental data, or a written-out proof) in an appendix  Always use a spell checker
  • 48. Visual structure  Give strong visual structure to your paper using  sections and sub-sections  bullets  italics  laid-out code  Find out how to draw pictures, and use them
  • 50. Use the active voice The passive voice is “respectable” but it DEADENS your paper. Avoid it at all costs. “We” = you and the NO YES reader It can be seen that... We can see that... 34 tests were run We ran 34 tests These properties were We wanted to retain these thought desirable properties “We” = the It might be thought that You might think this would authors this would be a type error be a type error “You” = the reader
  • 51. Use simple, direct language NO YES The object under study was The ball moved sideways displaced horizontally On an annual basis Yearly Endeavour to ascertain Find out It could be considered that the The garbage collector was really speed of storage reclamation slow left something to be desired
  • 52. Summary If you remember nothing else:  Identify your key idea  Make your contributions explicit  Use examples A good starting point: “Advice on Research and Writing” http://www-2.cs.cmu.edu/afs/cs.cmu.edu/user/ mleone/web/how-to.html