Tutorial: Writing

本页介绍写作相关的资源和技巧，希望能够缩短同学们使用tex的写作学习周期。 你可以下载这个文件作为开始写作的模板。

使用TeX写作

写作环境

• 本地环境

可以使用cTex，或者自行配置sublime+texlive。 这部分遇到问题请自行google.

• 云环境

建议使用overleaf写作，并将合作导师加为collaborator. 该网站可以直接访问。

文件结构

建议使用这个文件作为模板。

由于一个文章可能会多次投稿（令人悲伤的的故事😭），建议各位同学按照模板里面的文件结构放置文件，以做到即便修改了很多次，文件依然井井有条。

• 文件夹paper: 存放tex, bib, sty等纯文本文件，不同期刊/会议的投稿文件按不同文件名明名，如reliableOffload-infocom.tex, reliableOffload-tmc.tex；
• 文件夹graph: 存放eps, pdf等图片、表格用文件；
• 文件夹data: 存放数据、代码等。

投稿模板

文件夹中的cls文件为模板文件，通常IEEE的会议期刊需要使用IEEETran.cls作为模板，ACM的会议期刊使用acm_proc_article.cls作为模板。

• 使用方法：

将IEEETran.cls放入.tex相同的文件夹中，并在tex文件首行修改为\documentclass{IEEETran}。

• 使用正确的模板：

针对相应的会议/期刊，在其call for papers上寻找明确的模板使用要求，避免用错模板。

图、表、算法

请参考模板当中的用法，特别是表格，可以考虑使用\includegraphics来实现，避免复杂易错的表格排版。

引用、参考文献

• 文内引用

强烈建议通过冒号的方式对引用对象进行分类。 如\ref{sec:design}, \ref{fig:overall}, \ref{table:summary}等。

• 参考文献

强烈建议使用bib文件管理参考文献，bib当中每个item可以通过google scholar中的cite按钮直接下载。 但请注意下载下来的bib item往往存在格式不统一的问题，请手动调整，做到所有的reference格式统一。

写作逻辑

写作好坏的关键不在语言在逻辑。
——鲁迅

写作逻辑的顺畅，除了在工作过程当中反复推敲以外，在写作上有一些简单实用的技巧。 这里我们重点介绍两点，后续会不断更新。

问题驱动

在阅读一篇文章的时候，要保持读者的阅读兴趣，使其注意力集中，最简单的办法就是让他跟着你的文字一起思考。而做到这一点，问题驱动就显得尤为重要。 简单来说，“做什么”不重要，“为什么”很重要。 因此在介绍自己做的工作之前，务必讲清楚为什么要做这个工作。

• 段落设置

建议在条件允许的情况下，设置一个单独的Motivating example段落，通过一个简单易懂的例子，清楚地展示：

• • 当前的研究现状及存在问题；
  • 解决该问题能够带来怎样巨大的好处；
  • 解决现有工作问题的难点，以及相应的初步解决思路；

只有让读者充分认识到当前该领域的问题，以及相应的难点， 才能让他更好的理解我们的贡献。

• 具体展开

具体展开每个段落时，同样采用问题驱动的写作方式。 先讲面临的问题或挑战，再说我们的做法。

比如：In order to achieve accurate error detection, we need to collect a large amount of sensory data.

The existing link estimation schemes suffer from the XXX bias problem. Hence, we additionally adds a flag bit in the reserved field of the packet payload.

Top-down方式

读者一开始并不清楚文章的全貌，如果直接介绍技术细节，将会让读者无所适从。 因此，我们需要采用自上而下的方式展开写作。 先告诉读者问题的全貌，再分别介绍其中的细节。

• 整体逻辑
  • 文章架构：比如我们设计的系统包含三个模块，则应该在介绍具体模块之前，首先总结系统整体，明确告诉读者包含三个模块，每个模块起到什么作用，模块之间存在怎样的内在联系。
  • 逻辑展开：先讲结论，再讲原因。

• 段落展开：文章整体结构应该遵循Top-down的方式，每个段落每句话的展开同样应该遵循Top-down的方式。做到单独挑出每段开头的一句话，仍然能够形成逻辑完整的描述。