最近,我正在草拟一本用中文书写的英文文档技术写作指南。完成两个章节小样时,我发给一个做技术研发的朋友试读。没想到,不一会儿就收到了他的反馈:“完全看不懂!” 细问之下,方才意识到:我好像被“知识诅咒”了。
这两个章节小样是在 ASD-STE100 (STE) 的基础上整理出来的。原本我以为写得很浅显,但朋友却说“都是语法,太晦涩了”、“不知道 STE 是什么”、“看不懂示例里面的英语” ……
为了破除“知识诅咒”,本文尝试从技术写作小白的视角重新审视 STE 的立足之本和发展之源。
什么是 STE?
英语是当今世界上应用最广泛的国际通用语言,也是编写技术文档的第一语言。
很多国外企业,要么只提供英文版技术文档,要么使用英语起稿技术文档,然后再将英文版技术文档翻译成其他语种。
在国内企业中,这种模式虽然尚未普及,但华为等头部企业已经跃跃欲试,有风头渐起之势。
但在技术文档的读者(使用者)中,绝大多数人的母语并不是英语。甚至,很多技术写作人员也是如此。
根据《哈佛商业评论》中的数据,早在 2012 年全球就有约 17.5 亿人使用英语,约占全球人口的 1/4。其中,母语不是英语的人占 75% 以上。
相比于母语,大部分人的非母语词汇量是非常有限的。对于英语不是母语的人来说,结构复杂的句子、多义词、同义词以及生僻词等英语读物中常见的元素都会大大增加他们的阅读难度和阅读速度,甚至百思不得其解或产生误解。
对于航空航天、国防工业、船舶制造、机械设备等重工业领域,不理解或错误理解技术手册中的内容很可能会引发安全事故,甚至人员伤亡。比如,操作人员没有正确理解操作手册中的说明而进行了误操作,或者运维人员没有正确理解维修手册中的说明而维护不当或维修不当。
在这些行业中,英语不是母语的人占到 80% 左右。正是由于这些行业用户的实际需求(比如航空公司),旨在让英文手册(技术文档)易读、易懂、易译的 STE 应运而生。
早在 1986 年,STE 第一版就已正式发布。之后,STE 随着技术发展的脚步不断更新,每 2~4 年发布一次新版本。目前,最新版的 STE 是 2021 年 4 月发布的第八版。
如何使用 STE?
STE 由两部分组成:
- 写作规范(Writing Rules)
- 词汇表(Dictionary)
写作规范告诉技术写作人员应该如何写好每一个句子,如何将句子组织成条理清晰的段落,如何使用标点符号,以及特殊内容的写法等。比如,写操作说明时必须使用祈使句,每个句子里只能写一条操作指令,每个句子的长度不能超过 20 个单词。
写作规范中共有 53 条写作准则。有些准则可以使句子的语法更规范,有些准则可以使写作风格更统一。遵循这些写作准则,可以让技术手册简单易懂、条理清晰。
词汇表告诉技术写作人员应该使用什么词汇表达什么含义。词汇表中的词汇是根据一词一义的准则精心筛选出来的最简单、使用最广泛的词汇。
如果一个事物可以用多个词汇表达(同义词),词汇表只允许使用其中最简单的那个。比如,表达“开始”的单词有好多个(”start”、”begin”、”commence”、”initiate” 或者 “originate” 等),而词汇表只允许使用 “start”。
如果一个词汇有多种含义,词汇表只允许使用它表达其中的一个含义。比如,”fall” 有两个含义(1. 因重力作用而降落;2. 降低或减少),而词汇表只允许使用 “fall” 来表达“因重力而降落”。
如果需要表达“降低或减少”时,使用单词 “decrease”。
词汇表中共有约 900 个在技术写作中最常用的词汇。你可以把它当作基础词库,然后根据自己所在行业、项目或产品等实际情况增添专业术语库。词汇表(基础词库)和专业术语库的组合使用,使 STE 不仅可以化繁为简,还拥有足够的灵活性。
谁能使用 STE?
使用 STE 能让技术手册的阅读过程轻松愉悦,却丝毫不会减少技术手册编写过程的专业度。
STE 并不是普通英语的简易版。想要正确使用 STE,需要精通两门专业知识:
- 英语,包括英语语法
- 与产品有关的专业知识
编写英文手册,自然要精通英语。真正使用 STE 时,你会发现很多时候只更换几个单词是不管用的。你需要重新构思整个句子,甚至段落,才能使它们符合 STE 写作规范。这时候,绝对是考验语言功底的时候,英语不好怎么行?
STE 写作规范中的很多准则与语法有关。虽然语法很晦涩很无聊,但这是躲不过的坎儿。
理论上讲,只要具备了上述基础,再有一本 ASD-STE100,你就可以使用 STE 了。
但纸上得来终是浅,参加有针对性的 STE 培训可以加深你对写作规范的理解。毕竟,写作规范是基于很多实际经验总结出来的。只有知其然知其所以然,才能运用自如、收放有度,而不是单纯的死记硬背。
谁在使用 STE?
在商业航空领域,航空技术出版物规范《航空维修资料标准》 (ATA iSpec 2200) 和《飞机维修培训准则》 (ATA 104) 中明确要求使用 STE。此外,该领域内广泛应用的 S1000D 规范,也明确要求使用 STE。
由此可见,商业航空领域的企业编写技术文档时必须使用 STE。这些企业包括但不限于为波音、空中客车、劳斯莱斯等顶级制造商提供 OEM 的厂家们。
如今,STE 的应用疆域已经远远超出航空领域,延伸到国防工业、机械设备、医疗器械、电子产品以及很多高科技行业。