Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
133 lines (76 sloc) 7.7 KB

泛化智能(gi)文风指南

总论

妳是一名写作者(writer)。

或许妳不写小说、不写专栏、不写诗,甚至也不看小说、不看专栏、不看诗。但妳仍然是一个写作者。如今很少有工作可以完全脱离写作而存在,只要面对电脑,要么就是在用形式语言写作(编程),要么就是在用自然语言写作。

工作邮件、个人总结、演讲用的幻灯片、Slack 上的讨论、微信上的对话、社交网络上的只言片语……所有这些都是写作。

写作的水平和天赋有关,但一些基础性原则可以编成则例(guidelines)。在软件设计领域,一份好的设计则例可以规范第三方开发者,提升软件平台的整体设计品质。同样,一份好的写作风格指南(style guide)也可以让公司和组织对内与对外的文本保持风格上的一致。尤其是泛化智能的产品均为开源项目,所以文本对于我们与外界的交流至关重要。

优质写作不容易。但只要回避某些写作习惯,妳的文字就很容易胜过 80% 的人了。

一般性注意事项

〇、永远不要因为某个词汇或句式在当下流行而忙不迭地用它。

一、避免陈词滥调

写作时,成语或惯用语经常会第一时间跳入妳的脑袋(所以它们才叫成语)。当遇到这种情况时,请停下来思考这些表达是不是过于泛滥。被滥用的表达即便准确,也会失去效力。文字和食物一样,新鲜是第一要素。「一千个人眼里有一千个哈姆莱特」,真的吗?或许妳的读者/同事里大部分人并没看过《哈姆莱特》,看过的一百个人眼中也只有两个甚至同一个哈姆莱特。还有很多陈词滥调的用法并不能给句子带来额外的信息或更加新鲜的表达,例如「并没有什么卵用」在很多情况下简化为「并没有什么用」也并不会损失什么。

陈词滥调日新月异,请诸位随时跟进。

二、特殊文风

有一些特殊的文风类型并不适用于科技公司。比如我们常常会在新闻联播以及《人民日报》看到的中文。很多这些中文是完全合乎文法的正常中文,但有一种并不适用于科技公司的气质。「事情真的像 Twitter 用户想像的那样吗?带着这个问题,记者走访了美国旧金山 Mission 区的用户体验设计师 Adam。」这是完全正常的句子,但很难不让人想到《焦点访谈》。即便是「Twitter」, 「用户体验设计」这类潮词也改变不了这点。

如果你的句子读起来很像新闻联播,请改写。除此之外,也有很多文风并不适用于科技公司。比如另一种特殊文风是淘宝文风,一个开发者说:「亲,这个 Bug 修改了,请给 GAAS 个 Star 哦」,明显是不合适的。

三、不要害怕崇高

言不由衷的崇高是虚伪,害怕崇高是犬儒。

四、中文 ≠ 中华人民共和国公民使用的文字

妳知道「扩散」、「提案」、「以上」都是日文吗?妳知道「迷思」是台湾人对 myth 的翻译,随后被大陆借用的吗?中华人民共和国是目前最大的中文使用国,但中文和汉字在台湾地区、新加坡、日本、以及无数海外国家与地区同样是日常经验的一部分。我们一直在从国外引用新词,但我们也必须意识到大陆语文对其它汉语使用地区日渐增长的影响力。如今在香港、台湾和北美的中文报纸里都不难见到大陆的用词和句式,作为生长在中国大陆的写作者,我们应该力求对世界范围内的中文做出正面贡献。

五、不要耍小聪明

在上面关于特殊文风的段落里,我本来写的是:

淘宝文风是特殊文风的又一个子集。

在第二稿里我把它改成了现在的样子。使用子集这种词或许会让人觉得有「geek 趣味」,但应用类写作的目的是沟通,不是为了显示自己的文笔功夫、专业知识或是「脑洞」。每当妳灵机一动想到什么特别绝妙的形容或表述时,请停下来考虑一下如果不这么说是否会损失什么。

六、请确保中英文对应时的语义

泛化智能的绝大部分项目均会提供中英双语的文档。请各位作者在翻译完毕后务必二次检查英文是否反映了中文的含义;并且确保英文文档经过了英语母语者的审阅,以避免引起不必要的误会。

标点符号

中文

  • 一律使用全角
  • 请使用中文直角引号:「」为一级引号,『』为二级引号。(即「」是最外层的引号。)
  • 破折号是——(两个 em dash),不是 --(两个 hyphen),也不是—(一个 em dash)
  • 省略号是……(两个英文省略号),不是。。。,也不是......(六个点)
  • 用波浪线(~)有时会有很好的效果,但调味料放多了会咸。
  • 用斜杠表示「或者」的意思时,请用 /,不要用 \。

英文

  • 大小写乱用是绝对不可接受的。
  • 一律使用半角。
  • 逗号、分号、冒号、句号、感叹号、问号后留一个空格。
  • 省略号是 …。注意这是一个单独的符号,不是三个点。(若妳试图删除这个符号,会发现按一下 delete 即可删除,而不是三下。)
  • 破折号是 —(em dash),表示「从哪到哪」是 –(en dash,例如 1980–1992)。前者在 Mac 上可用 shift option - 打出,后者可用 option - 打出。在某些文字处理软件(例如 Word)里,连续打两个 hyphen 会被自动转为 em dash。
  • 括号和它外面的字母之间留一个空格,和它里面的字母之间不留空格。例:Richard D. James (aka Aphex Twin) is a pioneer of the so-called Intelligent Dance Music.
  • gi 作为公司名称的缩写,用在文章中需用小写字母。Gi 和 GI 等写法应极力避免。
  • GAAS 是 Generalized Autonomy Aviation System 的缩写,请务必在任何情况下均使用大写字母 GAAS。
  • GitHub 的大小写也要注意。

禁用词汇

在除了直接引语以外的任何情况下,禁止在文案中使用以下词汇。

  • 屌丝
  • 白富美
  • 高富帅
  • 高大上
  • 富二代
  • 红二代
  • 军二代
  • 安利(动词)
  • 撕逼
  • 尼玛(语气助词)
  • 也是醉了(是哪种醉了?请描述出来)
  • 有木有
  • 泛化(当用于形容公司名时,禁止将公司简化为「泛化」)。

当直接引语里出现上述词汇时,可以使用。但请使用正字。「撕屄」而不是「撕逼」。

常识性原则:不要讳饰。如果把某个词用汉字完整写出来令你不适,那么也不要用柔化过的变体把它写出来:不要用这个词。例:如果觉得「关我屁事」粗俗,那么写成「关我 P 事」并不会让你更不粗俗。

慎用词汇

  • 情怀
  • 物欲横流
  • 众所周知(请想想是不是真的众所周知)
  • 简约
  • 唯美
  • 精品(词本身没什么,但如果随便什么公司都说自己做的是精品就没有精品了)
  • 行为艺术(行为艺术和绘画艺术一样,是一种艺术类别,不可以用这个词来描述一切妳看不懂的东西)
  • Low(如果妳觉得一个东西「很 low」,请具体描述之。为什么 low?是哪种 low?)
  • 人工智能(除非是某些特定的宣传场合,人工智能应该用具体技术名称来代替)

特殊词汇

  • 飞行汽车与 VTOL(专业文章请使用 VTOL 来代表垂直起降飞行器)

数字用法

当只有一位时,使用汉字。两位以上(含)使用阿拉伯数字。例:山药至少有三种常见的做法。一年有 365 天。

阿拉伯数字前后请加入空格。比如「现在是 2016 年」,而不是「现在是2016年」。

最近更新于 2016 年。

You can’t perform that action at this time.