如何写科技论文How to write a technical paper

This is the evolving set of recommendations I share with my graduate students for technical writing...

    1. Empathy: This is the single most important principle of technical writing.  Try reading what you write from the perspective of somebody who has not spent the last few months working on your problem.  Better yet, find such a person and see if they understand everything you are talking about.  Don’t just take their word for it, ask them to tell you what they understand in their own words.  See where they struggle and debug your paper: Do they get lost in too much detail and miss the main point?  Do they get disoriented because you jump around too much?  Are there terms they do not understand?  Fix the paper using the following techniques until a dedicated freshman can understand all the important points.
    2. Winston’s Onion Rule: The document should state the most important points first, and expand on them gradually. It is a mistake to keep any important points until the end of the paper.  Only details and supporting material should be left to the end.  If I stop reading the document at any point, everything I haven‘t read so far should be less important than everything I have read up to this point:
      1. The title should be descriptive of the main point.
      2. The first sentence should state the main point.
      3. The first paragraph should expand on the first sentence.
      4. The first section should expand on the first paragraph.
      5. The first chapter should expand on the first section.
      6. The whole paper/thesis should expand on the first chapter, etc.
    3. Yuret’s Fractal Rule: Parts at every level of your document, down to each paragraph, should have their own introduction / conclusion to keep the reader oriented (i.e. stop them from asking “What is this person talking about now, and why?”):
      1. The first chapter of a paper/thesis should state the topic of the paper/thesis and the last chapter should summarize its point.
      2. The first section of a chapter should state the topic of the chapter and the last section should summarize its point.
      3. The first paragraph of a section should state the topic of the section and the last paragraph should summarize its point.
      4. The first sentence of a paragraph should state the topic of the paragraph and the last sentence should summarize its point.
    4. No undefined terms: Any technical term your nine year old niece would not understand should be defined before first use.  Any acronym should first be given in parentheses next to its long form before first use.  All variables in equations, all axes in graphs should be explained at the first opportunity.  Tables and Figures should have descriptive captions that can be understood stand-alone.  Technical terms and mathematical notation should be used consistently, no confusing variations allowed (i.e. calling the same thing context vector somewhere and word context vector elsewhere will confuse the reader into thinking these are two separate things).
    5. Replicability: Science is based on replicable results.   Your paper should provide enough detail (possibly in the appendices), and links to its code and data, to replicate each of its results.  In particular, for each set of experiments you should have:
      1. Data table: e.g. in a natural language processing experiment, things like number of words and sentences in train, dev, test; vocabulary size, tagset size, tag frequencies, out-of-vocabulary rate, average sentence length, i.e. any data statistic relevant to the task should go to a data table.
      2. Parameter table: things like the model structure, the training algorithm used, the hyperparameters used, number of training epochs, and any other details related to experimental replication should go to a table.
      3. Result table: the results (table or plot) should clearly indicate the evaluation metric, sensible lower bound baselines, upper bounds (e.g. inter-annotator agreement) if available, and current state of the art in published work to put your results in perspective.
      4. from: http://www.denizyuret.com/2016/03/how-to-write-technical-paper.html
时间: 2024-10-04 17:38:09

如何写科技论文How to write a technical paper的相关文章

写好英语科技论文的诀窍: 主动迎合读者期望,预先回答专家可能质疑--周耀旗教授

写好英语科技论文的诀窍:主动迎合读者期望,预先回答专家可能质疑 周 耀 旗印地安那大学信息学院印地安那大学医学院计算生物学和生物信息中心 以此文献给母校中国科技大学五十周年校庆 前  言 我的第一篇英语科技论文写作是把在科大的学士毕业论文翻译成英文.当我一九九零年从纽约州立大学博士毕业时,发表了20多篇英语论文. 但是,我对怎样写高质量科技论文的理解仍旧处于初级阶段,仅知道尽量减少语法错误.这是因为大多数时间我都欣然接受我的博士指导老师Dr. George Stell和Dr. Harold Fr

(转)如何写好英文科技论文

英文科技论文写作是进行国际学术交流必需的技能.一般而言,发表在专业英语期刊上的科技论文在文章结构和文字表达上都有其特定的格式和规定,只有严格遵循国际标准和相应刊物的规定,才能提高所投稿件的录用率.    撰写英文科技论文的第一步就是推敲结构.最简单有效的方法即采用IMRaD形式(Introduction,Materials and Methods,Results,and Discussion),这是英文科技论文最通用的一种结构方式.         IMRaD结构的逻辑体现在它能依次回答以下问题

写科研论文导师不传授的细节

写科研论文导师不传授的细节 当审稿人拿起文章的时候,总体印象起了很大的作用.审稿人的心理定势就是判断“过”还是“不过”,没有第三种选择.如果他的印象是“不过”,就反复找理由挑毛病.所以要想通过,首先要写得好,让审稿人挑不出毛病.而如何写得好?很多细节导师是不会传授的.悟性非常重要!以前的硕士生导师的科技英语写作水平非常好,有时候她修改别人的文章后,会把修改文章的思路和文章的写法传授给我.后来读博士的时候,导师的写作水平就更棒了,他虽然没有条条框框地指导,但是从反复修改文章的红笔文字中,我也悟到了

How to Write and Publish a Scientific Paper: 7th Edition(科技论文写作与发表教程)(11.04更新)

How to Write and Publish a Scientific Paper: 7th Edition(科技论文写作与发表教程)(11.04更新) 重要通知: 最近开题报告已差不多告一段落,准备发力写论文了.我会根据自己写论文的实践,从找期刊到发表的过程记录下来.记录的过程从第6章开始,我会用不同颜色的自己标注出来,其顺序大体和<科技论文写作与发表教程>的目录相似.欢迎大家讨论拍砖. 目 录 第一部分 一些基本常识 第1章 什么是科研写作第2章 历史回顾第3章 走进科技写作第4章 何

SCI科技论文的写作技巧-核心价值

第一次写SCI论文的撰写技巧,本身不是大牛,也许没什么资格谈这个.在此仅是个人的一些思考,对不对,好不好,且当另论. 对于偏向应用的工科生来说,写SCI论文不是一件简单的事情.当然,也不是没可能.全在于如何提取.构思.组织你的论文.论文本身的学术价值当然少不了.但对一个问题,在有的人眼里,就是"这么简单,有什么可写的":而对于另外一些人,却能挖掘出背后的深度.广度.和细度,完成一篇较高价值的论文发表.至于学术价值方面,在次就不赘述.主要谈一下如何来构思SCI的论文,简单概括就是四个字:

关于“科技论文的致谢”的几点建议

作者对为其科研工作和论文写作做过实质性贡献, 但尚不足在文章上署名者, 一般在文尾以公开致谢的形式来肯定给予的帮助和贡献.这虽无明文规定, 但已约定俗成.它既是搞科研做学问的职业道德, 又是编辑出版管理的需要, 理应遵循和严肃对待. 总的说来, 这个问题上论文作者处理是好的.但也常出现两种不良倾向, 一是对确实给过实质性帮助的人, 不公开致谢.论文的致谢, 实质上是作者署名的补充, 涉及被致谢者诸如荣誉等权益问题, 不公开致谢是一种侵权行为.二是致谢中写上未曾参与甚至未曾阅读过论文的名教授.专家

科技论文撰写的基本知识

文摘应具有独立性和自明性,并拥有与一次文献同等量的主要信息,即不阅读文献的全文,就能获得必要的信息.因此文摘是一种可以被引用的完整短文. 编写文摘时应注意:1.排除在本学科领域方面已经成为常识的内容;2.不得简单地重复文章篇名中已经表述过的信息;3.要求结构严谨,语义确切,表述简明,一气呵成,一般不分或力求少分段落;忌发空洞的评语,不作模棱两可的结论.没有得出结论的文章,可在文摘中作扼要的讨论;4.要用第三人称,不要使用"本人"."作者"."我们"

英语科技论文表述中常用的时态

英语句子中作谓语的动词发生的时间和存在状态不同,其表达形式亦不同,谓语动词的这种不同的形式称作时态.在写句子的时候,准确地把握句子的时态是科技论文写作中的关键之一.英语句子中的谓语动词虽然有16个时态,但在科技论文中常用的只有5种,即一般现在时,一般过去时,一般将来时.过去完成时和现在完成时.而用得最为频繁的只有一般过去时和一般现在时. (1)一般现在时态 用于正式发表的内容. Optically active amines bearing the stereogenic center as t

如何选择和阅读科技论文

转自 https://www.howsci.com/how-to-read.html# 作为一名研究生或者研究人员,每年可能要花费数百小时的时间阅读科技论文.通过阅读科技论文,可以对所研究领域有个大体认识,并且能了解所研究内容的最新进展,掌握最新的研究方法和内容. 但是部分人来说阅读科技论文并不得法,不仅浪费了大量的精力和时间,而且最后收获却很少.如何高效阅读科技论文,并且如何选择文献及如何阅读文献?本文作一介绍. 如何选择科技论文 现在信息发达,文献也是海量,刚开始如何选择文献阅读也是一门技巧