Friday 12 August 2016

publications - What's the point in "the paper is structured as follows"?


Inspired by the recent question on list of figures: what is the point of ending your introduction with a paragraph saying "The paper is structured as follows: in Section 1 we do BLAH, then in Section 2 we do BLAH, we move on with BLAH in Section 3, and conclude with Section 4 in which we do BLAH"?


Many papers in my area do it, my coauthors add them to our papers, and I kinda took the habit, too, but I never really understood why. It looks like a poor man's table of contents. After all, we already write what we plan to do in the introduction, and remind the reader in the conclusions.



Answer



Unlike Dave and Henry, I am going to argue against the style The paper is structured as follows..., though not against inclusion of content serving the same purpose.



Quite some time ago, I took to heart advice by Simon Peyton Jones on this, which can be found here (slide 19), also echoed by Sandro Etale in his advice on writing introductions. In essence it boils down to this:



Don't write The rest of this paper is structured as follows. Section 2 introduces the problem. Section 3 ... Finally, Section 8 concludes. That is most of the time only a waste of paper.


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.



In a consequence, the position I take on this part of writing introduction is that while it is important to inform the reader about the structure of the paper so that he/she can take the path of few surprises and easily follow the discourse, it should be however done with style. Doing it in such a poor manner as "The paper is structured as follows ..." is simply bad literature. I would argue, that it is better to firstly, clearly state the contribution of the paper and then write up the paper's plot summary leading from the introduction to the culmination of the paper in supporting the claimed contributions and discussion. I mention the references to the individual sections, and sometimes even deeper structural parts, only in passing, or include them in parentheses.


On a similar note, regarding Conclusion section, I took to heart the advice of D. J. Bernstein on writing conclusions. Citing other authors, he suggest to simply drop the conclusions part from papers and put all the important conclusions into the introductory section. Well, unless there really is something important to say there. Since then, I conclude my papers either directly by a loose paragraph at the end of the Discussion section (renamed usually Discussion and final remarks), or if I feel like there is something important to say, by a standalone short section Final remarks. However, never re-iterating what was done in the paper. The reader is anyway free to "rewind/relist" in the paper (see the very last point by DJB).


P.S. The links to homepages of the two guys include many more good tutorials on aspects of writing/research in computer science.


No comments:

Post a Comment

evolution - Are there any multicellular forms of life which exist without consuming other forms of life in some manner?

The title is the question. If additional specificity is needed I will add clarification here. Are there any multicellular forms of life whic...