这是一个关于Technical Communication和Technical Writer的入门介绍和概述。虽然有些这个公司打广告的成分,但是对于想要了解这个行业/职业的同学们,还是可以看看的,还比较全面。
点击:Careers In Technical Communication
...
这是一个关于Technical Communication和Technical Writer的入门介绍和概述。虽然有些这个公司打广告的成分,但是对于想要了解这个行业/职业的同学们,还是可以看看的,还比较全面。
点击:Careers In Technical Communication
...
作为一名technical writer,经常显示写作工具里的的隐藏标记来检查一些格式问题是个很好的习惯。在MS Word里也有不少隐藏标记,而且Word自己的帮助文档里并没有对它们全部进行说明。
要显示或隐藏格式标记,点击 Show/Hide 按钮(),快捷键是Ctrl+* (Ctrl+Shift+8)。在Word 2010里,也可以通过 File > Options > Display 设置平时需要显示哪些标记。
...
今天看到同行通过Google Trends对Technical Writing技术写作近几年的发展趋势作了分析(“技术写作走下坡路?”),结果挺令人意外的。不过自己的从亲身经历和观察来看,Technical Writing在中国这几年还是有发展的,需求也是有增长的,虽然速度不是很快。顺便search了一下另外几个关键词:technical writer, technical communication, customer education。从结果上看, 印度完胜啊,应该是因为软件业发达,英语国家,劳动力也比较廉价的原因吧。
...
作为technical writer,大家都知道一般的style guide对于文档章节的标题,都建议使用title case。究竟什么是title case,有什么特别要注意的地方?是不是每个单词的首字母都要大写?是不是一旦看到像in, up, on这样的小品词就小写?
先来看看这个例子:
Percentage of Approved Releases that do not Result in an Incident
...
最近在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.
举两个简单的例子:
...
今天抽空听了 Ellis Pratt 为 Madcap 做的一个 Webinar,主题是"Affective Writing: Turning Technical Documentation into an Emotional Experience for the User"。我们知道,目前主流的 Technical Documentation 的 Writing Style 是要避免太口语化,富有情感,或带有宣传色彩的表达。一方面的原因是这样的风格让技术文档显得不太专业,另一方面是如果涉及到文档的本地化,这样的语言不好翻译。
...
前段时间一个 native speaker 和我们讨论下面两个说法应该是用哪个,parameter 的名字应该是放在前面还是后面的问题。
1. The xxx paramenter has been introduced in this release.
2. The parameter xxx has been introduced in this release.
...
Tom 在 College Funding Resources 组织的 Career 100 中介绍 Technical Writer 以及他个人的经验和建议。Technical Writer 确实不只是 Writer,工作也不仅仅是写文档,所以很多的技术文档工程师更喜欢 Technical Communicator 这个名称吧。不过能像 Tom 的那样只有 20% 的工作时间是在 Writing,估计很多国内的公司都做不到,呵呵。
想要了解 Technical Writer 这个职业的同学可以去听一听:
...
上周五老板给我们发了一篇关于 RTFM 的文章 The Blame Game of RTFM,写得挺有意思的,writer 和 user 都要共同努力才能减少 RTFM。这个idratherbewriting博客很早就知道了,博主 Tom 对 technical writing 充满热情也很有见解。我要多多向前辈学习,希望以后也能写出很多有见解的文章。哈哈~
普及一下,RTFM 是 Read The F**king Manual 的意思,其实自己也是最近才知道。自己也顺便多了解了一下关于 RTFM 的解释,没想到 iOS 自带的词典也有解释:read the f**king manual (used esp. in e-mail in reply to a question whose answer is obvious)。因为其中的 Fxxking 不太和谐,很多人也把 F 替代成 Friendly, Fine, Fantastic, Foolish 等等。与 RTFM 类似 ,STFW (Search The F**king Web) 和 UTFG (Use the F**king Google) 也都是用来表达明明可以自己查找到答案,却要将这些问题拿出来提问,让回答者感觉浪费了自己的时间。