科普:写好结构化论文的10条规则
学位论文写作
布雷特•门斯(Brett Mensh)和康拉德•科尔丁(Konrad Kording)总结出了写好结构化论文的10条规则。它们是对论文各种层次上的结构的一种解剖,可以让我们对论文写作要求产生整体性了解。门什——科尔丁规则突出以读者为中心的写作、要求在各种层次上遵循规范的结构且按某种迭代顺序书写论文。最后还给出了如何验证是否满足10条规则。
以读者为中心的写作要求
——规则1-4
写作是一种交流。与谁交流呢?当然是与读者交流,也因此,写作要以读者为中心。门什——科尔丁规则的前四条规则可以帮助作者在写作的过程中不要忘了读者。
规则1 : 用标题突出读者可以记住的问题或中心思想
标题是论文的第一个元素,读者最先看到论文的标题。你的论文本身的目的不是像报表一样堆砌所有数据和其它结果,而是需要从复杂的数据中提炼出重要的结论。
如果你涉及的问题较多,就需要对许多信息进行分析,看哪一方面更重要,看能否凝练出一条具有高度概括性(multi-facet)的“单一问题”标题。读者们很难记住许多事情,但也许能记住一条信息。
规则2:用通俗易懂来面对“平凡”的读者
该规则的原文是“将读者当作不懂你工作的血肉之躯”,即不要认为读者也像你一样是这篇论文的顶级专家,而要把他们看成天真的读者。写作的时候试着像是你在和别人说话一样:看脸说话,抱着向人说清楚的态度写作,这样你就可以直接而清楚地说出来。
用通俗易懂的语言吸引读者关注你的问题,进一步让他们在付出较小代价的情况下理解你的结论。比如说,对一些难懂的技术术语给出清晰的定义,让读者能理解它们的意义。尽量避免使用缩写和首字母缩写,避免读者回到前面去再次识别它们。
有些核心内容必须让读者记住,以便阅读论文的余下部分并最终记住你的主要贡献。 相比于中间的内容,大家更善于记住开头和结尾的内容。因此,在每一节或每一段落,把最重要东西放在开头或者结尾处。
规则3: 背景-内容-结论(C-C-C)规则
论文的上下文结构,每一节、每一段的描述是否可以有某种统一的逻辑顺序来安排内容? 第三条规则就是针对这样的逻辑顺序。将描述简单分为开始、中间和结尾三部分,要求有一个清晰可辨的开头、一个意义明确的主体部分和一个结尾。规则3要求这三部分分别是背景或来龙去脉、内容和结论,简称为C-C-C结构,这里的三个C,按顺序分别指Context, Content和Conclusion,即背景、内容和结论。开头交代背景或来龙去脉,中间介绍主体内容,最后将故事一步步推进到给出结论的结尾。
一开始就交代背景或缘由,可以让读者理解“为什么告诉我这个?”。作为结尾给出结论,让读者不会疑惑“那又怎样?”。中间放入的内容让读者看到你的论点由背景到结论会有根有据。
这种“背景优先”的模式不同于“内容优先”的结构,“内容优先”的结构可能会让读者错过对“为什么告诉我这个”的交代。基于这些原因,提倡将C-C-C作为“默认”的科学论文结构。
论文的宏观架构包含引言、结果和讨论,是一种显式的C-C-C结构。其中引言设置了背景,结果是内容,讨论带出了结论。对于论文中的每一段落,使用C-C-C结构要求将该段的第一句用于交代背景,中间部分的介绍内容供读者思考,结尾用结论让读者记住。
规则4:直白地表述你的结果
通俗地说,就是直来直去地表达结果。学术论文不是小说和散文,不能将论文写成曲折动人的风格。
首先,需要避免绕来绕去。只有论文的中心思想才应该被多次提及,中心思想以外的主题应该只出现在一个地方,以尽量减少主题更改的次数。相关的句子或段落应该串在一起,而不是被无关的内容介绍打断。例如,用于解释一件事的两个原因应该一个接着一个的出现,而不能被隔开。
其次,对一些具有平行地位的内容,使用并行法则介绍。具体而言,如果你有几项地位平行的内容需要介绍,那么分成地位平等的段落,用相同的语气和风格逐一介绍这些平行的内容。并行结构使文本更容易阅读,因为读者熟悉这种结构。
例如,如果我们有三个独立的原因来解释为什么我们更偏向于对结果的某一种解释,那么用相同的语法来表达这三个独立原因。这样读者对结构熟悉后,就可以专注于内容。
在一个句子或段落中多次使用同一个单词表达同一个意思没有错。如果试图使用不同的单词,读者会觉得第二个词有稍微不同的意义。
遵循规范的宏观结构
——规则5-8
论文的宏观结构包括摘要、引言、结果和结论等。第5-8规则主要是讨论如何应用C-C-C法则来优化这些结构或者突出重点。
规则5: 在摘要中要讲清楚一个完整的故事
对大多数读者来说,摘要是他们唯一会阅读的部分。这意味着摘要必须有效地传达论文的全部信息。为了达到这个目的,摘要的C-C-C结构是高度规范的。
按C-C-C结构,摘要首先是交代背景。第一句话通过介绍特定研究所在的更广泛的研究领域来引导读者。然后,通过交代目前的研究空白以及弥补这一不足的重要性,即具体的研究空白与论文开头的广泛研究背景之间的联系,研究范围被缩小,直到最后收缩到文章所研究的问题。这样,将读者的目光聚焦在该论文的内容上。
接着是交代内容,即对方法(新方法、新途径)进行介绍以及对研究结果进行概述。
最后,结论部分会解释所得到的结果,以回答背景部分的末尾提出的问题。有时,还需要指出这个结论对于推动该研究领域有何作用(例如,“更广泛的意义”)。
这种规范的结构可以帮助你避免摘要中一些常见的错误,即在读者还没有理解问题之前就先讨论结果。好的摘要通常需要经过多次的改进,以确保结果能够像密钥适合锁一样填补研究领域的空白。这种宽-窄-宽的结构让你能将文章传到给更广泛的读者(通过广度),同时还能保持你的结果的可信度(基于有限或狭窄的结果)。
规则6:在引言中说明论文的重要性
这种重要性通常是通过一组逐渐变得更加具体的段落来完成的,这些段落以对文献中所缺乏的内容进行清晰的阐述为结尾,然后是一段总结文章如何填补这一空白的段落。一段段的进阶陈述引起了读者对论文内容的期望。
引言每一段的结构(最后一段除外)都是为了引出最终的研究领域空白。每一段首先将读者引向主题(一个或两个上下文句子),然后解释相关文献(内容)中的“已知”,然后到达关键的“未知”(结论)。沿着这条路,常常会有线索告诉你研究空白背后的秘密;这些线索引出了未经验证的假设或未发展的论文方法,并给读者希望,让他们相信问题是可以解决的。引言不应包含超出论文动机的更为广泛的文献综述。这种聚焦于空白的结构使有经验的读者很容易评估论文的潜在重要性,他们只需要评估文章中所述的研究空白的重要性。
规则7:含图形的结果介绍顺序遵循支持中心论点的逻辑
结果部分需要让读者相信主要结论是由数据和逻辑支撑的。每一种科学论证都有其独特的逻辑结构,这种结构决定了其要素的呈现顺序。图形在结果展示中往往具有重要地位,做图本身就是一门艺术,爱德华·塔夫特(Tufte)的书仍然是学习这种技艺的黄金标准。勾画出图形如何支撑你的结果的逻辑结构,并将其转换为一系列声明性陈述,这些陈述成为结果部分中各小节的子标题。
正式介绍结果时有一些段落,每一段落的开头都会使用一两句话来交代该段落要回答什么问题,如:“为了验证之前没有相关工作……”,“我们方法的可重复性有多少?”,或“接下来我们测试了是否有什么结果。”
每个段落的中间部分给出与问题相关的数据图形和逻辑,段落以回答问题的句子结尾。每一段都要使读者相信最后一句话所给出的答案。这使得读者很容易找到得出可疑结论的段落,并检查该段落的逻辑性。每一段的结果都是一个逻辑陈述,而文章中更靠后的段落依赖于前面段落的逻辑结论,就像数学文献中建立的定理一样。
规则8:在讨论结果时突出填补的空白以及本研究的局限和意义
讨论部分通过对结果的概括、对局限性的讨论等来解释文章的工作如何填补了引言部分提出的研究领域的空白并对一些解读提供警告。另外需要描述论文研究是否提供了推动该领域发展的新机遇。
在讨论部分的第一段,需要特别地概括结果部分的重要发现。有些读者跳过了结果部分的一些重要内容,所以这一段至少让他们了解该部分的要点。
例如,第一段可以总结结果,集中于它们的意义。第二至第四段可能涉及潜在的不到位的地方,指出其它文献解决了这些不到位的地方,或者可以通过未来的研究来弥补这些不足。第五段以对该文章如何推动该领域前进的描述结束。渐渐地,读者学会了把文章的结论放到正确的语境中。
准备论文的顺序
——规则9/10
有效地分配时间和选择正确的写作流程可以使论文书写更容易和更有效。
规则9:在标题、摘要、图表和提纲等重要的地方分配时间
边研究边逐渐积累文档对最终获得论文提纲是有用的。你应该根据每个部分的重要性来分配你的时间。阅读标题、摘要和图表的人比阅读论文其余部分的人多得多,而方法部分的阅读人数最少。需要对此做出相应的平衡。
可以通过预先规划来有效地分配花在每一节上的时间。这需要预先写一个提纲,可以为每一个计划的段落预先写一个非正式的句子,这可能会成为每一节或子节的标题。因为文章有一个整体的轮廓,所以每一段都应该在推进内容的过程中有一个明确的角色。这个角色最好在大纲阶段被仔细推敲,以减少在那些最终不符合整体内容的段落上浪费时间。
对你的论文写作时间做一个估计,将这个量乘以三就是你真正需要的时间。一次性无修改写作的要求很高,很容易低估写作所需的时间。把你最初的估计夸大三倍更现实。
规则10:在删除、重新利用和循环迭代中建立反馈机制
写作可以看作是一个优化问题,在这个优化过程中同时改进你的故事、提纲和所有的句子。有时写好了一些东西,但发现写得不好。改它需要花费很多时间,还不如删了它重写。这就是我们常说的一张白纸好写字。
写好一篇论文需要从多方得到反馈。第一步是找人试读。试读还可以提供有价值的信息,非常具体的反馈通常会指出段落中逻辑不充分的地方。以一种积极的方式接受这种反馈是至关重要的,因为来自他人的意见是至关重要的,所以一群乐于助人的同学是你能书写好论文内容的基础。
如何验证你是否满足了10条规则
下面给出你是否违反了这10条法则的迹象。发现这些违反良好写作的行为有助于在各个层次提高论文的质量。
规则1:论文是否专注于一个中心思想?违反迹象:你和读者不能对论文给出一句话的总结。
规则2:是否做到了将论文写给天真的人?违反迹象:读者“抓不住”该文章的要点。
规则3:是否遵循了背景—内容—结论的C-C-C逻辑结构?违反迹象:读者对一些事及其所表示的含义有疑问。
规则4:逻辑流程是否得到优化?违反迹象:读者被一小段文字绊倒。
规则5:摘要是否紧凑地总结了论文?违反迹象:读者在读完你的摘要后,不能对你的文章进行“电梯间演讲”。
规则6:从引言能看出文章重要吗?违反迹象:读者对你的文章没有太大兴趣。
规则7:结果验证了结论的合理性吗?违反迹象:读者不认可你的总结。
规则8:在讨论中是否有批判性段落,是否介绍了对未来研究的影响?违反迹象:读者的脑海中会留下一些你没有回答的批评、问题。
规则9:你合理分配时间了吗?违反迹象:尽管你努力写作,但读者很难明白你的核心结论。
规则10:你反复迭代过论文吗?违反迹象:试读的人反对文章的结论。
▷翻译:学位论文写作 公众号写作团队
原文
【1】Mensh B.,Kording, K. 2017.Ten simple rulesfor structuring papers. PLoS Comput Biol 13(9):e1005619.
【2】 Mensh B, Kording K. 2017. The PLOS ComputationalBiology Staff Correction: Ten simple rules for structuring papers. PLoS Comput Biol 13(11): e1005830.
原文指出的图形制作参考文献
Tufte E. 1990. Envisioning Information, Graphics Press:Connecticut.
Tufte E. 1997. Visual Explanations, GraphicsPress: Connecticut.
Tufte E. 2001. Visual Display of Quantitative Information,2nd editionedition,Graphics Press: Connecticut.
Tufte E. 2006. Beautiful Evidence, Graphics Press:Connecticut.