Archive for the ‘技术传播’ Category

Writing for Your Audience

2013年3月22日

Always keep your audience in mind when you write something. This is probably a golden rule for all kinds of writing. As technical writers, we also need to take care of our audience. Following are some writing guidelines for you to achieve that.

Understand your audience

In most cases, people who read technical documents are looking for answers to some specific questions. No one reads technical documentation for entertainment. So keep your document clear, straightforward, and task-oriented.

...

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!