Some Specific Tips About Technical Writing | Kip S. Thorne
The Feynman Professor of Theoretical Physics, Emeritus
California Institute of Technology
基普·索恩（Kip Thorne），美国理论物理学家，加州理工学院教授。2017年因“对LIGO探测器及引力波探测的决定性贡献”，与莱纳·魏斯及巴里·巴里什共同获得诺贝尔物理学奖。
我在1987年，为博士研究生和博士后写了这份文件。其中的大多数内容在今天依然适用。—— 基普·索恩，2018年10月
写作过程
- 确定你的读者，并仔细思考应该如何与他们交流。
- 确定文章的目标。
- 认真选择发表的期刊。与之相关的问题是：它能被你所期望的读者们读到吗？它要收版面费吗？它接受电子手稿吗？(这可以避免恼人的排版错误和校对过程)
- 在写作之前，要确认自己明白期刊或者出版商的写作格式要求。
- 阅读格式说明手册。
- 找一些这个期刊或者出版商出版的文章或者图书，作为格式参考。
- 确定你的文章应当完善到什么程度，并为之努力。要记住，“完美是优秀的敌人”，但是“马虎会毁了你的信誉”。
- 列出文章的大纲：
- 首先，列出一个长长的列表，包含所有的项目。可以先不要管顺序。
- 接下来，确定几个主要类别（它们将成为文章的各个章节），以便将这些项目归类。将每个项目移到其中一个类别中。
- 调整并组织每个类别中的项目。
- 完成整个文章的大纲。
- 不同的人喜欢不同的写作方法。Kip自己喜欢的写作方法大概为：
- 首先，我写出一个粗糙的引言。
- 然后，我在文章的正文部分做大量的工作，并不断进行修改。正文会“有组织地”成长，并随着发展而变化。我研究工作的大部分是在写正文时完成的——这是我为了使我的想法变清晰而不断努力的自然结果。完成后，正文与我原始大纲中所设想的文章几乎很少有相似之处。
- 正文完成后，我将回到引言部分并完全重写它。
- 最后我才写摘要。
- 现在文章就在电脑上了（要么是因为它最初就是在电脑上写的，要么是因为有人对其进行了文字处理）。除非在极端情况下，否则我不会将文章交给那些需要用活字重排全文的期刊或者出版商发表。因此，要么使用电子手稿，要么用相机影印，电脑上的版本就是最终的发表的版本。
- 然后，我至少要遍历整个论文两次，从头开始检查所有方程式（不看原始的推导）。这使文章更加可靠，并可以发现拼写错误和数学错误。
- 在发表之前，请他人对文章进行评论。
文章的组织结构
- 文章要呈现的内容通常在逻辑结构上并不是线性的。要考虑使用图形、脚注、附录和方框（仿照MTW【译者注：MTW是指Charles Misner，Kip Thorne，John Wheeler合著的《Gravitation》一书】那样）作为工具，在文章中呈现这种非线性的重要内容。
- 不同的读者将会阅读文章的不同部分。按照下面的规则写：
- 标题会被庞大的读者群体阅读。它应该提供有关论文主题的明确信息，并应吸引很大一部分读者进一步阅读。
- 摘要会被大量的读者阅读。应当让其中的非专业人士可以理解摘要的大部分内容。尝试吸引尽可能多的读者以进一步阅读。同时，提供足够的细节，以使相关方向的专家想要进一步阅读。他们通常是您最希望呈现给的读者。考虑摘要的篇幅，尽量的准确。确保它包含文章的所有要点。
- 引言将由中等程度的大量读者所阅读。与摘要一样，要让包括非专业人士在内的读者都容易理解。关于如何写一个可以吸引大量读者的引言，斯蒂芬·霍金(Stephen Hawking)1973年以后（也就是在《时空的大尺度结构》之后）的文章，就是很好的参考范例。要考虑将引言写成“引言和总结”。指明在正文的哪些地方，可以找到与引言中描述的项目相对应的技术细节。
- 插图将被那些泛读的读者所浏览，并且经常被那些阅读摘要的读者所研究。要考虑写一个合适的插图说明，使读者无需阅读文章就可以理解插图。
- 正文面对的是对您来说最重要的读者，也就是文章主题方面的专家。不要浪费他们太多时间，去呈现他们已经知道的内容，除非这是一篇综述文章。确保正文对他们来说非常清晰，并且如他们期望的那样简洁。确保正文和附录可以提供足够的细节，以使真正的专家可以毫不费力地重复出您所做的工作。当然，也不要提供过量的细节使得非专家也可以轻松地重复出您所做的工作。除非您写的是综述或者教学文章，或者专家读者确实需要这些内容。将必要的细节放在附录中，以免妨碍文章主体内容的呈现。
- 适时地使用章节和小章节来引导读者。
插图
- 在科技论文中，插图是呈现信息的一个非常强大的工具。为绘制一个出色的插图而花费几个小时甚至几天时间都是值得的。约翰·惠勒（John Wheeler）和罗杰·彭罗斯（Roger Penrose）就是榜样，他们的插图非常有效。可以找来看看。
- 彭罗斯在三维物体方面，是一位出色的专家。他会利用透视、阴影、点刻法、以及精心放置的不种厚度的线条来绘制物体。可以从他的图形中学习这些技巧，并尝试模仿。
- 考虑使用计算机来生成图形。如果做得好，它们会比人绘制的图形效果更好。对于二维图形，Macintosh上的Macpaint和Macdraw之类的东西就足够了。而优质的三维绘图软件包才刚刚开始以合理的价格提供。
方程
- 如果你将要面对排字工人，那么有一些特别的建议：在格式说明手册中或在期刊或出版商的已发表文章中查找可用的字体，并相应地编排你的公式。提交文章时，请附上一份副本，上面要为排字工人或编辑人员清楚地标明各种特殊符号的含义。如果数学很复杂，则为了确保审稿编辑没有出现严重错误，请要求在排字处理之前，先给你发送审稿版本进行检查。检查毛条校样时，以几种不同的方式检查每个公式，以查找打字错误。要检查提交的原稿，检查你的原始计算，甚至在时间允许的情况下，从头开始重新推导每个方程，并对照毛条校样对其进行检查。如果等式中存在大量错别字，请要求提供第二次的校样。不要以为出版人员第二次就一定能正确处理它们。
- 除非显而易见，否则在文章中要为读者提供有关如何得到方程的详细说明。例如，“通过组合方程式（17），（36）和（12），然后根据边界条件（35）积分并选择积分常数，我们得到…”。
- 在大多数期刊和书籍中，方程被视为行文的一部分，并且必须有标点符号（方程的末尾应该有逗号，分号或句号）。检查是否正确标上了标点。
- 数学符号通常不应该用作动词。例如，不要写“When the sky is blue, A=B.”而应该写“When the sky is blue, A is equal to B.”如果出现例外，则应仔细考虑清楚。
- 句子通常不应以数学符号开头。例如，不要写“H is used to denote the horizon, while J denotes infinity.”而应该写为”The symbol H is used to denote the horizon, while J denotes infinity.” 。
- 不要在文本中间使用组合方程, 任何组合方程都应单独写为显示方程。
- 当方程太长而无法放在一行上时，请仔细谨慎地选择要在哪里换行，以及开头如何与前行对齐。
- 仔细确定哪些符号要用斜体，哪些符号要使用罗马体，哪些使用粗体等等。具体请参见格式说明手册或者示例文章。比如，在下标和上标中，由两个或两个以上字母组成的字符串，如果代表的是单词或短语，那么通常应当使用罗马体，而不是斜体。
- 如果要将文章提交给《Physical Review》，那么在对您的文章进行文字处理之前要仔细阅读《Phys. Rev. Compuscript Manual》手册，并且最好从刚开始写文章时就尝试遵守其规则。这将减少你后面的痛苦。注意，我们电脑上的troff宏包是与Phys. Rev. 兼容的。
- 给每个可能被读者引用的方程做编号。否则，读者使用您的论文时将非常不方便
引用他人的工作
- 如果工作是由别人完成的，请确保对别人给予了完整的认可和尊重。没有比这更重要的科学礼节。要非常清楚地表明您文章中的哪些是新的内容，哪些不是。如果不是新的内容，请清楚地标明引用。
- 引用长篇文章或书籍时，请引用具体的章节、页码或等式，使得读者可以在其中找到您要引用的内容。
行文
努力使你的行文平滑顺畅，即使在（尤其是在）非常技术性的论述中也是如此。一个重要的方法是仔细措辞，特别是在段落的开头，以某种方式（通常是细微地）回溯到前一个句子或段落。如果没有这样的“连接措辞”，文章看起来会像是从一个项目跳到另一个项目。读者可能会对你的思路是从哪来的到哪去的感到迷惑。
使用下面的技巧使逻辑上复杂的材料变得清晰容易阅读：
- 在一个长的论述的开始处，使用一个介绍性段落。说明从现在开始要有一个长的论述，并且粗略指明这个长的论述会有多长，以及解释它会由哪些部分组成。
- 在论述的每个部分的开头，使用一个句子说明该部分是关于什么的。而在末尾部分，使用一个句子来说明这个部分结束了，你将要继续进行下一个部分。
- 在行文和标点中使用“平行结构”（也就是说同一结构连续使用两次或多次），用以表明某些项目彼此相关。
- 对具有逻辑关系的项目（比如句子的从句）使用编号。使用（i），（ii），（iii）或（a），（b），（c）来编号。不要使用（1），（2），（3）来编号，因为这可能会和方程的编号混淆。
- 将长且复杂的句子分解成几个短句。除非你使用了并行结构或编号使得长句子易于理解。
考虑你想要呈现给的那些读者，使用适合他们习惯的写作风格。在这方面，一个失败的例子是霍金(Hawking)和埃利斯(Ellis)的《时空的大尺度结构》。虽然是写给物理学家读的，但它的大部分内容是用数学家的语言和风格习惯写成。霍金告诉我，回想起来，他后悔使用这种风格。与之形成鲜明对比的是霍金最近的论文，以及彭罗斯(Penrose)为物理学家所写的那些论文。同样，适合理论物理学家的风格通常并不适合《The Astrophysical Journal》的读者。
尽量避免使用性别代词，尤其是阳性代词（he,、him、his），除非是特指某一个男性。最好使用”one”、”one’s”或者”they”、”them”和”theirs”。
例如：不要写“The reader will understand this if he has studied Hawking and Ellis”，而应写成“Readers will understand this if they have studied Hawking and Ellis”。但是也不要忘了英语的语法，不要写成”The reader will understand this if they have studied Hawking and Ellis.” 。
其他一些需要注意的点：
在同一句或相邻句子中同一单词的多次出现，会在读者的脑海中相互“共鸣”，从而打扰读者的思考。避免使用这种会引起“共鸣”的单词组合。除非你是利用平行结构为表达复杂的论述而故意使用它们，或者将其作为“连接器”以使行文流畅。
通常应当避免在段落中改变语态，例如从主动变为被动或变成祈使。也应当避免改变设想中的动作执行人，比如从“one”变为“they”或“you”。
通常应避免使用双重否定，不只是说一个否定紧接另一个否定，还有在一个句子的单个从句中使用两个否定词。
通常应当避免使用分裂不定式，当然并不绝对。
通常应当避免使用悬垂分词。
通常，应将单词或短语的所有的修饰语以及逻辑上与其紧密联系的事物，放置在其附近。不要把它们悬垂在句子中某个遥远的地方。
例如：句子“We shall study spacetimes that are, in some suitable sense to be described below, similar to Schwarzschild.”中”are”是悬垂的。为了避免悬垂，可以写成“We shall study spacetimes that, in some suitable sense to be described below, are similar to Schwarzschild.”。
通常，应当避免将单词或短语的修饰语拆分开来，将一部分修饰语放在其前面，另一部分却放在其后面。而应该将它们全部放在单词或短语的同一边。
例如：句子“These equations, when written in terms of partial derivatives, become a system of first order linear partial differential equations, after we combine with Eq. (17).”中的“become a system of first order linear partial differential equations”是被修饰的部分，修饰语分别跟在它的前面和后面。所以这句话可以改写成“These equations, when written in terms of partial derivatives, and when combined with Eq. (17), become a system of first order linear partial differential equations.” 。