None-2019/01-Improving Your Technical Writing Skills

[BrambleXu]

Summary:

这篇论文是教如何写好英文文章的。

提倡简洁，比如使用短句，使用简单的单词和短语。具体的写法涉及到使用主动与台，personal鱼台，使用动词而不是名字。

Google社のテクニカルライティングの基礎教育資料がとても良かったので紹介したい: 这份google的资料也挺不错

Resource:

• pdf

Notes:

2. Before you start writing

• 把目标写在报告的开头
• 想象一个具体的读者，他不知道很多相关的背景，但对这个话题感兴趣
• 决定报告需要包含哪些信息。可以使用目标来作为参考，或者想象不清楚背景的读者
• 多用字典查不熟悉的单词
• 找人给自己反馈。自己写博客找反馈比较难，但如果是工作上的文件，可以找前辈要反馈

把draft给别人看之前，先确保自己做了下面的事项：

• 检查文章的结构，看有没有违反规则
• 用语法检查工作过一遍
• 把自己当做潜在读者，认真读一遍

3. Using plain English: style

根据文章的种类不同，目的不一样，需要写的内容也不同：

• 写推荐的文章。希望读者接受你的推荐。
• 写调查。希望读者明白你做了什么，以及为什么这个是重要且有效的

结构：

• 3.1 and 3.2：如何让写的内容更容易明白
• 3.3 and 3.4：使用更少的单词
• 3.5 to 3.7：不要使用一些结构不好的句子或表达
• 3.8：如何解释new ideas
• 3.9：取名要保持一贯性
• 3.10：在不添加复杂度的前提下，设置一些规则

3.1 Sentence and paragraph length

1. 一个句子只包含一个单一信息。为了不让句子变得复杂，要谨慎使用一些复合连词，比如and, or, while。
2. 检查句子是否错误使用了逗号，让句子变长了（查看4.3如何正确使用逗号）
3. 节俭地使用括号。绝对不要使用嵌套的括号！

多使用主动语态，可以有效减少句子的长度。

不仅仅是句子要写短，段落也要写短。一个段落应该只包含一个前后连贯的观点（coherent idea）。一个段落应该少于半页。另一方面，如果有很多个连续的段落都非常短，这是因为自己的思考没有逻辑。如果每个句子要表示不同的观点，那么最好使用项目符号或枚举列表。

3.2 Bullet points and enumerated lists

如果一个段落里的句子之前需要连续起来，那么可以用枚举列表。如果互相之间没有顺序关系，那么可以用项目符号。

如果每个项目都很短的话，不需要加任何标点。否则，应该每个项目最后都加一个句号。

3.3 Using the simplest words and expressions possible

The golden rules on words and expressions to avoid are:

• Replace difficult words and phrases with simpler alternatives;
• Avoid stock phrases;
• Avoid legal words and pomposity;
• Avoid jargon.

3.3.1 Replace difficult words and phrases with simpler alternatives

除非上面那些词是在特殊语境下，否则就不要用。比如render在建造领域和计算机领域有特别的意思，但如果是表达make的意思，那么还是应该用make。

3.3.2 Avoid stock phrases

3.3.3 Avoid legal words and pomposity

不要使用法律用语和一些没有必要的指示代词。（在中文语境下法律用语倒是并不常见）

（针对最后一个例子，我习惯使用指示代词，以后要注意一下）

3.3.4 Avoid jargon

如果我们假定的读者都是专业领域的人，那么不需要对一些专业名词进行解释。比如搞NLP的人知道NER是什么意思。但是如果我们的读者还有其他领域的人，那么就应该在专业用语出现的时候给出定义。

3.4 Avoiding unnecessary words and repetition

很多句子会把一个观点用不同的话重复说明，这会浪费空间并使传达的信息不够清晰。

一些不必要的内容大多是一些“抽象”的词带来的，比如nature, position, character, condition, situtation。对这些词的使用要谨慎一些。

还有一些情况是一句话里有冗余的部分，此时可以删掉那些不必要的单词：

3.7 Using personal rather than impersonal style

尽量使用第一人称，使用I, My, 不要使用第三人称，不仅写法上句子会变长，而且容易有歧义。如果非要用第三人称，使用One。不过这种情况下，更推荐使用We。
（我之前还用过You呢。。看来以后要好好注意这方面的写法了）