Archive for the ‘Grammar’ Category

It's 还是 its?这真的是一个问题?

2013年6月4日

以前一直以为It's和Its这么一个简单的语法问题,应该不会有人会弄错。可是在现实中,在需要使用its的地方却用了it's,这个错误在我帮工程师review文档的时候已经出现过不只一次,之前认为这应该只是个笔误吧。

bob's quick guide to its and it's from angry flower

...

关于标题的 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.

举两个简单的例子:

...

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

...