Archive for the ‘Dan’ Category

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.

...

Word 转 PDF 目录(TOC)链接无效

2012年10月23日

有时候用 Adobe 的插件将 word 文档转成 PDF 的时候会发现转出来的 PDF 的目录不能像原来的 word 文档一样通过点击鼠标进入相应的章节。这是因为在 word 里生成生成目录的时候是用的 page number 而不是 hyperlink。要解决这个问题很简单,只要在生成目录的 Table of Content 菜单中将 Use hyperlinks instead of page numbers 的 checkbox 选中,然后再输出 PDF 即可。

...

[Podcast] Technical Writer Career

2012年10月22日

Tom 在 College Funding Resources 组织的 Career 100 中介绍 Technical Writer 以及他个人的经验和建议。Technical Writer 确实不只是 Writer,工作也不仅仅是写文档,所以很多的技术文档工程师更喜欢 Technical Communicator 这个名称吧。不过能像 Tom 的那样只有 20% 的工作时间是在 Writing,估计很多国内的公司都做不到,呵呵。

想要了解 Technical Writer 这个职业的同学可以去听一听:

...

RTFM

2012年9月19日

上周五老板给我们发了一篇关于 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) 也都是用来表达明明可以自己查找到答案,却要将这些问题拿出来提问,让回答者感觉浪费了自己的时间。

First blog

2012年8月26日

First blog on www.technicalwriter.cn/blog.

Hello, world!