写作
- Metadiscourse 元话语
- https://explorationsofstyle.com/2017/01/31/metadiscourse/
- https://idaho.pressbooks.pub/write/chapter/metadiscourse/
In philosophy of language, Metadiscourse is the discussion about a discussion, as opposed to a simple discussion about a given topic. Metadiscourse contained within a written work can be any phrase that is included within a clause or sentence that goes beyond the subject itself, often to examine the purpose of the sentence or a response from the author, usually as an introductory adverbial clause. Metadiscourse often includes phrases such as “frankly,” “after all,” “on the other hand,” “to our surprise,” and so on.
Below are some examples of metadiscourse in writing, denoting:
- the writer’s intentions: “to sum up,” “candidly,” “I believe”
- the writer’s confidence: “may,” “perhaps,” “certainly,” “must”
- directions to the reader: “note that,” “finally,” “therefore,” “however”
- the structure of the text: “first,” “second,” “finally,” “therefore,” “however”
Checklist
- 引用文献（参见“细节”一章）
- 引用文献是不应使用
In [xx]，而应该用In xxxx's work [xx]等叙述替代 - 如果句子较长，引用的方括号应跟随在人名之后
- et al. 应为斜体！使用代码
\textit{et~al.} - 引用与正文内容中间应空一格
Perhaps the most popular is the amsmath package [7]，而不是Perhaps the most popular is the amsmath package[7]
- 引用文献是不应使用
基本的逻辑
- 形式服务于内容
满足论文的格式要求、表现方式固然重要，但是文章最重要的是从头到尾的逻辑连贯性，需要进行取舍
- 一篇文章会有最主要的贡献，次要贡献，还有为了体现出这个贡献搭建的系统（这个系统包含了其它组件）。那么如何提炼并且强调最主要的贡献？解决问题的核心是什么？
- 例如文章过长，是否要舍弃首页顶部的图？图能更好的吸引读者，但是因为文章页数要求，是否会影响放入更多的内容？
- 是否需要某个单独的章节？如果添加了这个章节，是否会打乱文章的逻辑顺序？比如相关文献和自己的工作的特点应该如何进行对比？内容是否要穿插？
文章的结构与框架
论文标题
- 论文的标题应包含什么内容？
- 不同的侧重点，可以同时兼顾两个方面：
- 论文中采用了什么方法解决问题？（对方法进行了优化，例如在同样的数据库上有了性能的提升）
- 解决了一个什么样的问题/场景(task)？（解决了个新的问题，实现了以前不能实现的功能）
- 如果是提升某个方法的性能或者进行改进/引入了新的解决方案，而对应的测试包含多个场景，在题目中只提及方法 可能论文采用了比较简单的方法解决了一个以前没有解决过的问题，这样标题中就可以弱化1)的部分，例如只提到方法的大致分类
- 起标题应该和检索文献一起来做，在检索的过程中希望找到什么样的文献，有什么自己会关注的关键词？
- 不同的侧重点，可以同时兼顾两个方面：
何时开始写作：
- 有阶段性进展后：
- 将代码转化为流程图形式，一方面为写作做准备，同时也帮助自己审查代码，找出其中的逻辑错误。这个流程图应与工作进展同步，及时删补。
- 根据流程图进行相应段落的写作
写作时应先做什么：
- 首先完成论文的概述部分，确定论文的整体框架
- 文章的重点：写作这篇文章的目的/意义是什么？有哪些关键细节？有哪些细节可以忽略？文章的侧重点是什么（focus）
- 论文主要目的是传达概念（concept）
- 不应当根据具体的耗时和有多少细节来分配篇幅，一些细节的调试可能会很耗费时间但是没有必要在论文中大段出现。
- 论文的层次
- 上层：立意/创新点
- 中层：章节到章节、小节到小节之间的逻辑与过渡
- 下层：段内的行文逻辑
- 行文的逻辑 应当保持逻辑的连贯性。例如先从概念性的角度进行叙述，再引入相应的实例/实现，一步一步进行叙述。
- 对于过长的术语，可以考虑使用缩写（acynomn）以节省长度，避免显得过于重复。
摘要（abstract）、贡献（contribution）、结论（conclusion）三部分的区别
| 段落 | 形式 | 内容 |
|---|---|---|
| 摘要 | 一段简短的总结 | - 读者阅读此文时应该期待有什么收获？ - 这篇论文是关于什么内容的？ |
| 贡献 | 可以是单独的一个章节，也可以是引言中的最后一段 | 这一段要详细的将贡献列出（细节）。可以尽可能的详细，但是要注意突出重点。 |
| 结论 | 阅读全文后应有什么收获？ | - 强调项目的影响力（highlight the impact） - 包含之后准备进行的工作（include future work） - 总结论文的关键点（conclusive remark of the paper） - 并不一定是一个非常完整详尽的总结，可以非常简短 |
摘要
- 应最先写abstract！
- 先写作摘要的目的是列出文章的重点与要强调的部分，指导后面的写作
- 摘要的内容：
- 为了处理一个什么样的问题而引入了新的方法？
This paper/article introduces a (new/novel) ____（方法分类，如feedback control，reinforcement learning等，也可以没有这个分类） framework/method/approach to/for __what task__ 对这个方法/框架进行概述
- 设计这个方法的目的/这个方法带来了什么好处？
- 几句话叙述实现的架构
- 进行了怎样的测试？
- 结果如何？
- 为了处理一个什么样的问题而引入了新的方法？
- 修改示例 示例一
关键词
- index term和keyword的区别： index term是帮助editor选择reviewer的，keywords是自己选择，帮助读者更好的了解paper的，强调paper的观点
引言与有关文献
- Introduction的逻辑链：
- 开篇介绍：问题的背景，如工业应用
- （若将有关文献作为引言的段落）相关文献，解决方法
- 工作的重要性是什么？现在其他人的工作中尚未解决的问题是什么？
- 从有关文献、调查文献（survey paper）等中总结问题，和重点
- 这篇论文的贡献（应优先完成这一部分！）
- Intro的写作，不应局限于特定的格式（例如一定要先写motivation，再写related works，然后写limitation，最后写contribution，不需要先定好子标题，再填入内容）而是要从motivation开始，根据逻辑进行展开，有什么别的研究试图解决这个问题？存在什么缺陷？自然的延伸到相关工作上，最后带出contribution
有关文献的写作
相关文献写作的要点
- 整体段落写作思路，也是由一般到特殊，有什么general problem（如不少文献都将其列在limitation中，或是这个领域常见的尚待解决的问题）？可以引用文献综述，提出一个问题列出多个文献。有哪些文献有其特殊之处？如用特殊的方法部分的解决了问题，但是还留有一些未解决的缺陷，相对详细的叙述这个文献
- Related work can be part of the introduction. Content of introduction: the need for this work and what is missing in other literature.
相关工作可以作为引言的一部分。引言一般的内容：为什么需要进行这项研究？这个研究的哪些部分是在现有文献中缺失的？
- 问题：什么情况下Related work单独列一节？如何平衡Introduction和Related work中的内容？
- Not being neutral to related work: be critical, put down what has been found, what has not been found yet.
写related work的时候不要保持一个中立的视角，辩证的去读文献，哪些是已经发现了的，哪些是还没有发现/还没有做过的
However, there is a lack of study to
- Introduction和related work部分的写作：
- 准备一篇笔记用于整理相关文献，将相关论文的表格通过块引用的方式整理为备用相关文献
- What kind of result do you want to show? What is the contribution? 写Result的时候思考希望展示什么样的成果？本文的贡献是什么？
- 时态问题：一般现在时用的比较多，也会用过去时或者现在完成时
- is represented by xxxx, represents, some approaches are emerged focusing on xxx,
- xxx was recently introduced, xxx were previously presented
- xxx methods have been attempted in xxx
相关文献的更新，多篇论文间相关文献的区别
- 相关文献应当随看随新，有新的会议尤其要注意文献的更新。
- 自己在准备多篇论文的时候，引用文献可以根据不同论文的研究方向侧重的区别，强调不同的方向，align with new research points，new perspective。
- Talk in a different way
- 根据研究之间的区别选取不同的引用文献
- 是否有之前写作时遗漏的？（new perspective）
引用文献综述类论文
- 综述类论文包含了多篇引用文献，可以直接引用一篇综述，并对其进行叙述从而一次性引用多篇论文。
引言中的总结陈词部分
- 分为三个部分
- 第一，解决了什么样的问题？
- In this paper, we address the open problem of ____
- This paper address the problem of
- In this paper, we present our work that …
- In this paper, the proposed xxxx method…
- 第二，通过列表指出工作的贡献
- The XXX approach has the following characteristics
Specifi cally, the paper presents a novel approach for general-purpose robot wrapping operations with the following characteristics:
- it uses real-time perception of the objects and wrapping state to determine and adapt the robot motion for accomplishing and improving wrapping operations to achieve high-quality results;
- it re-uses and adjusts the canonical motion of making a single wrap of the DLO around the other object to be flexible to the length of the DLO (thus the length of the coil as the wrapping result) and to enable constant check and improvement of wrapping quality with feedback control;
- hence, it is able to achieve high-quality wrapping without requiring prior knowledge of the physical and geometrical properties of the DLO and the other object.
- 第三，论文剩下部分的结构，每一个章节的内容
- The rest of the paper is organized as follows
- This paper is organized as follows
正文结构：
- 每个段落各自有其要强调的重点
- area reference
- more specific
- if your paper did something to improve that, point it out here
- more specific
- area reference
任务Task
- 不要直接在章节下写子章节，应当有一段引言先阐述提出的想法，在这个简单的intro中介绍思路 Always place an intro between section and its’ first subsection. Present the idea first.
- 如何定义论文所叙述的Task？系统所预期实现/完成的任务是什么？
文章的结构：
- 进行研究的动机是什么？
- 提出了什么样的解决方案？对解决方案进行解释阐述
- 给解决方案定性，实现了什么效果，有什么优势什么劣势
- 在定义了Task之后下一节可以开始写Method/Approach
- 不要放入其它内容，对任务结果的评估应放在实验一章中。
- 符号化的对问题进行定义与表述（how to symbolic describing your problem）
- 先对使用的符号/方法/术语进行定义 对符号的定义要尽可能遵照传统/约定俗成的规则 Precursive of the methodology: some notation you will use, predefine stuff ()
实现Approach/Method/Implementation
-
章节开篇可以从逻辑上分为两段进行叙述
- 首先应进行铺垫/引入，为什么要采用这样的方法（approach）。Give people idea of why you do it before what to do. 例：
Our approach is to enable the manipulator to learn how to make a high-quality helix of the DLO around the target through repeating and improving each single wrap along the helix.
- 随后再进一步对方法进行概述。对于多个步骤，可以考虑使用子标题。
More specifically, our system first conducts target estimation: Using…
-
在写使用了一项技术时，需要解释/阐述为什么要用这项技术？目的是什么？相对以前的方法有什么提升？
-
语态问题
- 在描述系统的处理流程/算法的时候，用the system…或者被动语态，不要用“we do something”，从而表现是系统自动完成了某一个过程，而不是作者人工处理后再交由系统处理。
- 在叙述问题是，例如：描述问题的假设时，可以用”we assume something“，表现出这一过程时作者设计的。
- 避免使用”the manipulator/robot do something”，使人感觉是机器人自己完成了什么工作。而是要强调我们设计的算法完成了某一工作。
-
写作时避免拉列表的现象（avoid to write things in a laundry list）
- 列表用于强调论文中重要的点，应当避免滥用。
- 列表应遵从一定的逻辑顺序
- 在使用列表时，为每一项起一个标题（give it a title），再紧跟一段进行阐释，使得段落更易读，并且更简洁，例
- 使用“Using sth…”，“Generating sth…”的句式使得读者意识到你在做什么。句式要统一（对于配图的标题也一样）
Discussion
- 讨论部分应相对中立，涉及方法的优势和不足
- 应当有侧重点，不需要对所有现象都进行讨论。
- 关键是使用了这种方法，与没有使用这种方法时相比，带来了什么样的优势？ 通过对比告诉读者这个工作的重要性（the significance of this work）
结论Conclusion
- 结论部分的内容：文章总结（summary），文章所作出的贡献（contribution）
- 完成了哪些，哪些没有完成？这部分将是读者重点阅读的部分
- 结构：
- 总结
- In this paper, we have introduce a new __方法__ 去解决什么样的问题
- 我们的方法实现了什么功能？有什么优势？
- 结果如何？
- 有什么样的应用场景？
- 之后的工作？
- In the next step (of this research)/Our next step is to/Future work includes
Future work一两句带过即可，下一步计划的研究对象是什么？可能涉及什么方法？不需要详细的写出下一步的计划是如何实现的。例如：
In the next step, we will expand to using other types of rods, for instance, solids of revolution other than cylinders, such as a cone（计划如何对方法的应用进行推广）, and to incorporate tactile sensing（引入什么样的方法）.In the next step, we plan to investigate more efficient means （不需要具体列出means是什么） to select the best uncertainty estimate based on probabilistic reasoning. The goal is to increase the speed of the assembly process in spite of complex shapes and tight tolerances of the assembly parts for efficient real-world applications（简述目标）. We will also test our approach on more varieties of parts and on complex parts of much smaller sizes, such as some actual power plugs and sockets（简述，应用到更多其它部件）. In real-world operations, a vision-based system can be added to approximately locate the target assembly part and limit uncertainty ranges（使用视觉方法，但是具体是什么样的方法不需要叙述）.
- In the next step (of this research)/Our next step is to/Future work includes
Future work一两句带过即可，下一步计划的研究对象是什么？可能涉及什么方法？不需要详细的写出下一步的计划是如何实现的。例如：
- 总结
- 结论这段不需要很长，甚至比abstract还短也是可以接受的。
写作中的审阅
- 反复阅读： 写作过程中如何从读者的角度阅读草稿提出问题
- 对某一处进行修改后要注意上下文相关的其它地方有没有也需要进行修改的。
语言
行文
- 参考文献：
- Style lessons in clarity and grace, by Joseph Williams and Joseph Bizup
- Writing Science: How to Write Papers That Get Cited and Proposals That Get Funded, by Joshua Schimel
- Scientific Writing and Communication, by Angie Hofmann
- 论文的核心是如何解释实验数据（interpret data）
用正面的词语
- 比较两个例子
- Not all the sections are shown （负面，没有表明为什么有些部分没有显示）
- Only the relevant sections are shown （正面）
Weak verbs
- 典型的weak verbs：
- 寻找文章中所有的“to be”（各种形式，如is，are，was，has been，had been，will be，will have been等等） be会有很多种解释，根据上下文不同更换一个更精准的动词，使得表意更tangible
- make、do、have、give
- give a presentation改为present
- make a prediction改为predict
- have a realization改为realize
- Look for important actions hiding as nouns (e.g. “variation” instead of “vary,” “development” instead of “develop”)
Weak subjects
- Weak subjects，Vague subject，抽象的概念难以具象，要避免用多义词或weak verbs解释抽象的感念
- Ask yourself “who” or “what” is doing the action. Who/what is being affected? Are those “characters” the subjects of sentence?
- Vague pronouns “it” and “this”. If they start your sentences, they may be unclear, especially if the “this” is followed by a verb (“This allowed for …“)
- Look for “there is” and “there are”, and other passive voice structures, that hide the main characters unintentionally.
Delayed subjects and verbs
- underline the first 5 or 6 word of the main clause of the sentence (you can ignore short introductory phrases). Do you see a subject and verb?
- Are your subjects and verbs close to each other? Or are there lots of interrupting words or phrases in between?
Missing “flow”
- Read the first few words of each sentence. Do you find any repeated key words from the previous sentence, or just brand new information?
- 简单，易于理解的先表述，随后进行解释
- Look at the subjects of each sentence in your paragraph. Do they name a consistent set of concepts/terms? Or does each sentence jump to a new subject?
- A->B, C->D, E->F
- A->B, B->C, C->D
- A->B, A->C, A->D
- 长短句如何配合？
- 写作的重要性：如何传递信息使得其适应不同层级的听众
用词
- We depict, introduce, provide, describe, present, analyze, outline
- We define, denote
- correspondingly, respectively
- Without losing generality
- Our general approach consists of __ stages, which we briefly introduce in this section
- The following subsection discuss/solve…(problem)
- Once, next
- The system applies, employs, introduces
- with respect to the world coordinate
- the reason is as follows: something
- To what extend can we use … to discover …
- Always use “coordinate system” or “coordinate frame”，don’t use “coordinate” along.
语法细节
- Repectively，搭配复数动词
The values of x and y are 3.5 and 18.2, respectively
- an RGB camera，参考Quora
RGB is an initialism, where every letter is pronounced individually, as opposed to an acronym, which is pronounced as a word. The letter R is itself pronounced as the word are, starting with a vowel sound. Therefore the proper indefinite article to use is an. Whether to use a or an is dependent on sound, not whether the first letter is actually a vowel or a consonant.
- data为复数单词，不是单数形式！
- 不存在its’的表述方法，所有格是its
- 不要滥用、曲解已有名词，如果使用术语，保持术语的原本含义
- 不要滥用上下标
使用符号
行内列表（Run-In lists）
- https://erinwrightwriting.com/how-to-write-run-in-lists/
- 何时使用分号：项目的内容中需要用逗号分割
Chicago boasts many famous foods, including hot dogs with mustard, onions, relish, and peppers; deep-dish pizza with chunky tomato sauce, mozzarella cheese, and pepperoni or sausage; and Italian beef sandwiches.
Whiting, Indiana, offers an annual pierogi festival; a beach-front park with a walking path, picnic areas, and musical events; and proximity to O’hare, Midway, and the Gary/Chicago International Airport.
- 用数字作为序号
My three most popular YouTube tutorials are (1) “How to Delete Extra Spaces in Microsoft Word,” (2) “How to Use Track Changes in Microsoft Word,” and (3) “How to Use the Comment and Mark-Up Tools in Adobe Acrobat DC.”
Currently, the best new country singers are (1) Cody Jinks, (2) Tyler Childers, and (3) Cody Johnson.
细节
引用
-
引用的格式：
- 引用文献是不应使用
In [xx]，而应该用In xxxx's work [xx]等叙述替代 - 如果句子较长，引用的方括号应跟随在人名之后
- et al. 应为斜体！使用代码
\textit{et~al.} - 引用与正文内容中间应空一格
Perhaps the most popular is the amsmath package [7]，而不是Perhaps the most popular is the amsmath package[7]
- 引用文献是不应使用
-
如果在journal paper中引用同一个作者的多篇文献怎么处理？
IEEEtran will produce citation numbers that are individually bracketed in IEEE style. (“[1], [5]” as opposed to the more common “[1, 5]” form.) The base IEEEtran does not sort or produce “ranges” when there are three or more consecutive citation numbers.
-
缩写：先写明全称，再在括号内注明缩写，如
long short-term memory (LSTM)
配图与表格
- 配图与表格的标题
- （包括子标题）内容应当完整，在阅读后即可理解配图的用意而不需要去原文中进行阅读。可以由一到两句话构成。不应当刻意追求简短。
- 配图的标题的语态应统一，最好使用被动，例如”Extracted object”、“Obtained data”，表现出“通过什么方法，完成了什么任务”。 ^figure-caption
- 何时出现配图：应尽可能的先定义问题再出现配图。可以为了排版方便/美观出现在同一页。
- 图应清晰，足够大以看清细节
- 图中的每个符号是否进行了解释？（在正文中）
- 引用图例
as shown，shown in - 曲线图、折线图、柱状图应使用不同的标记样式、线条样式或者填充纹理区分不同数据，因为读者可能用黑白打印或者有色弱的情况
- 数据表格应设定一个统一的浮点数精度（如统一保留一位小数）
定义、引理、定理，为符号进行定义
- 在给出Definition之前不需要介绍，先完成定义，然后在定义之后进行解释
- 上下标、重音符：
- 避免上下标的堆叠，使用函数、在不同位置的符号表示不同的涵义，如
表示Convex Hull， 或 表示投影 表示cavities，如 、 表示其它含义
- 上标/下标表示在一个集合中的序号
- 用下标
表示连续时间，下标 / 表示离散时间，如果下标被时间所占用，则用上标表示序号
- 避免上下标的堆叠，使用函数、在不同位置的符号表示不同的涵义，如
算法
- 文字、伪代码、流程图的选择：
- 文字：非常简单的算法
- 伪代码：算法流程相对线性（flat, a list of task, linear）
- 流程图：更具有普适性的算法，更多分支选择、循环和交互（more interaction），尤其是状态转移、自动机等的图
- 算法也应和配图标题一样，能够自行解释
- algorithm: self-contain, not to cluster, variable better define in your paragraphs first (equations) There is a need to have a paragraph that fully explain your algorithm/equations
公式
- IEEE publications do not typically use the word “equation,” but rather just enclose the equation number in parentheses
引用文献
- 使用Zotero或其它工具自动生成引用文献后需要检查格式和条目
- 期刊名进行缩写
- 删去不必要的部分，如ISSN/ISBN，出版商等。如果空间不够，会议论文可以删去页数。期刊可简写为
5(2):371-395，即vol(number):page