Archive for the ‘Writing Style’ Category

英文技术写作笔试

2013年4月9日

笔试基本上已经成为很多公司招聘技术文档工程师过程中的一个必不可少的步骤了,特别是在招聘母语不是英语的英文技术文档工程师的时候。通过笔试能够大致了解应试者的英文基本功,技术文档写作水平,分析能力,是否足够细心等等。

因此,笔试的结果也将很大程度上影响应试者最终能否应聘成功。个人认为,笔试的结果对于衡量一个技术文档工程师的比重可能占到50%甚至还要更多。在我面试过的候选人中,其实就有不少面试感觉很不错,可是最后因为笔试成绩不理想而没被录用的,我觉得挺可惜的。

好了,其实今天写到这个话题是因为看到了一个Tech Writer 在线测试的网站,还挺有趣的,所以在博客里给想成为英文技术文档工程师的同学们推荐一下。之所以推荐是因为这个测试简单明了,而且不需要花很长的时间,就可以对自己的不足之处有一个了解。据说还真有公司用这个测试来进行笔试的。需要说明的是,题目还是比较简单和基础的,适用于比较初级Technical Writer的测试(暗自庆幸自己基本上全都做对了,呵呵)。

下面是这个网站的地址,有兴趣可以去试一下:

...

关于标题的 Title Case

2012年12月13日

作为technical writer,大家都知道一般的style guide对于文档章节的标题,都建议使用title case。究竟什么是title case,有什么特别要注意的地方?是不是每个单词的首字母都要大写?是不是一旦看到像in, up, on这样的小品词就小写?

先来看看这个例子:

Percentage of Approved Releases that do not Result in an Incident

...

Simplified Technical English (STE) 简化英语

2012年11月30日

最近在Linkedin上面看到同行关于Simplified Technical English (STE)的讨论,自己也去稍微了解了一下。STE即简化英语,属于受控英语,通过对所使用英语的用词和用法给出明确的规定和限制,让文档对于用户变得更清晰,更准确,更易于理解。

STE的全称是ASD-STE100,ASD的意思是AeroSpace and Defense。 从这个名字我们可以知道,这个STE标准最早是用于航天航空和国防方面的技术文档。ASD-STE100最早被使用是在上世纪80年代,现在它已经不仅仅可以用于航空领域,就像在它在官方网站上声明的一样,STE可以用于任何技术文档,包括软件文档。这也很好理解,STE使用最多的是航空航天行业,可以想象而这些行业文档所描述的对象是非常复杂的,并且对语言的准确性和确定性的要求也非常高。如果STE (简化英语)可以满足航空航天这样高技术高要求行业的需求,那么对于其他行业的文档应该也可以很好的支持。 Specification ASD-STE100由Simplified Technical English Maintenance Group (STEMG)进行维护和更新。

简单的说,STE的主旨就是: Only use approved words and keep to the approved meaning of a word, as specified in the STE Dictionnary.

举两个简单的例子:

...

Affective Writing (Emotional Elements) for Technical Documentation

2012年11月15日

今天抽空听了 Ellis Pratt 为 Madcap 做的一个 Webinar,主题是"Affective Writing: Turning Technical Documentation into an Emotional Experience for the User"。我们知道,目前主流的 Technical Documentation 的 Writing Style 是要避免太口语化,富有情感,或带有宣传色彩的表达。一方面的原因是这样的风格让技术文档显得不太专业,另一方面是如果涉及到文档的本地化,这样的语言不好翻译。

...

"The xxx parameter" vs. "The parameter xxx"

2012年11月2日

前段时间一个 native speaker 和我们讨论下面两个说法应该是用哪个,parameter 的名字应该是放在前面还是后面的问题。

1. The xxx paramenter has been introduced in this release.

2. The parameter xxx has been introduced in this release.

...