Archive for the ‘2012 November’ Category

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 是要避免太口语化,富有情感,或带有宣传色彩的表达。一方面的原因是这样的风格让技术文档显得不太专业,另一方面是如果涉及到文档的本地化,这样的语言不好翻译。

...

Technical Writer Community in China

2012年11月12日

上个周末一个同行打来电话,说12月份可能会在上海筹划一个 technical communication 的沙龙。联想到最近在一些同行的博客以及 Linkedin 上面看到上个月在北京大学也举办了类似的活动,据说参加人数远超预期,达到了120人,而且气氛很好,大家都很积极。不禁要感叹一下,techinical communication在中国从几年前的萌芽发展到现在,已经有越来越多的人从事这项工作,因此自然也就有了需要一个(或多个)组织来促进大家的沟通交流,推动行业发展的需求。很高兴看到自己从事的行当有了发展和进步,希望上海的活动也能举办成功。自己有时间也会去参加,向同行学习。

另外,顺便提一下,由于自己也在开始做关于 technical writer 的 blog 及网站,所以时不时也会关注一下同行是否也有在写相关博客。我发现从这一两年开始,一些中国同行也开始在记录他们的工作经验和体会,虽然数量还十分有限,但比起几年前的已经多了不少(以前基本上只能看到 native speaker 的记录)。哈哈,这么说来,自己是不是也在为这个 community 在中国的发展在做一些贡献呢,至少以后想入行的同学们如果搜索到我的网站或 Blog 的话,可以或多或少的了解一些相关的信息吧。

下面是我看到的其中一个中国 writer 的博客,内容也还不算多(但是比我的还是要多不少,哈哈,我太懒了。。。。),大家可以时不时关注一下:

...

"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.

...