Archive for the ‘技术文档写作’ Category

读者就是上帝!还是老奶奶?

2013年6月6日

今天偶然又看到了以前曾经看过的一个段子,那时候还没有自己的博客,所以现在就记录一下吧。

这个段子是这样的:

我们年轻人都知道Facebook,可是如果有一天,一个老奶奶问你什么是Facebook的时候,你会给出怎样的解释呢?她会明白吗?

...

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

...

术语管理在技术文档写作中的重要性

2013年6月1日

今天看了Content Rules上的一篇whitepaper,标题是"Shepherding Your Content for Operational Efficiency"。这篇文章详细阐述了术语管理(Terminology Management)对于提高文档写作效率和提高内容效用的重要性,并给出了应该如何进行术语管理的建议。

Graphic - Shepherding Your Content for Operational Efficiency

的确,从我个人的经验来看,许多公司在文档写作中对于术语或者说是用词用语的管理,真的就像文中所说一样,通过Word或者Excel来维护一个词汇列表,又或者是把它加入到公司所谓的style guide中并加上使用说明。

问题出现了,大家真的会经常查看这样术语列表吗?

...

[Webinar] How To Write Powerful Sentences & Paragraphs

2013年5月29日

这是Marcia Riefer-Johnston于2013年5月18日的一次Webinar,主题是"Language Matters: How To Write Powerful Sentences & Paragraphs"。

Marcia有着二十多年的technical writing经验,也在大学里教过tech writing的课程。

...

Content Wrangler 2012 技术传播行业调查结果 – 技术写作工具

2013年5月6日

这两天Content Wrangler公布了他们的2012 Technical Communication Industry Benchmarking Survey 的调查结果。这个调查的样本包括了超过500家的公司,而且这些公司都是比较大型,有大量文档需求,并且有自己的技术文档部门的,所以这个调查结果应该还比较具有代表性吧。

2012 Technical Communication Industry Benchmarking Survey by Content Wrangler

浏览了一下,调查结果大都是在意料之中,比如Structured XML越来越普及;85%的公司都会进行Content Reuse;最大的挑战是缺少Content Strategy等等。个人比较关注工具方面,其中比较意外的是Adobe和Microsoft的工具在工具TOP 10排名中占了大部分,而FrameMaker则是排在了第一。许多比较流行的技术写作工具并没有上榜,个人认为这可能是因为这个调查并没有把技术写作工具和其他支持工具(比如截图工具、图片编辑、和视频工具)及制作培训材料(比如Microsoft PowerPoint)的工具进行区分,榜单位置有限。

下面是一些工具相关的调查结果:

...

eBook是如何创建出来的?

2013年5月3日

随着移动手持设备(主要是手机和各种pad)的不断进步和普及,电子书(eBook)也越来越被人们广泛使用。一本制作精良、互动性上佳的电子书能够带来良好的用户体验,从而促进内容的传播。

那么一本eBook是如何制作出来的呢?Aptara公司通过下面的一张图片向我们简单介绍了eBook的制作过程。不知道国内是不是也有这样专注于数字出版和移动设备内容的公司呢?个人认为,这对technical writer来说也是一个值得关注的领域和发展方向,毕竟电子阅读和移动阅读也是大势所趋。也许以后我们输出的文档将不只是直白的pdf,还会包括互动性更强的eBook了。

create an ebook introduction

...

Adobe RoboHelp or MadCap Flare?

2013年4月23日

Adobe RoboHelp和MadCap Flare都是擅长开发web help的authoring工具,哪一个更好用呢?RoboHelp是老牌工具,一直有不错的口碑,而Flare则在最近几年发展迅速,越来越多公司的文档开发转向了Flare。 

就我个人而言,也更推荐Flare,原因包括:方便灵活;功能强大;更新快;售后支持不错等等。比较想特别提出的是,Flare比较与时俱进,比如对HTML5和Mobile的支持就体现了未来文档的发展方向,又比如在Flare 9中为web help加入的community功能,可以让文档和用户以及用户和用户之间进行互动,作者也可以及时了解用户对文档的反馈。

...

(中国)技术文档工程师的工资待遇

2013年4月8日

在STC intercom 2013年1月的一篇名为"Technical Communication in China: A World to Be Won"的文章中给出了对中国技术文档工程师的工资调查结果,平均工资大约是5500元人民币。个人觉得如果是在一线城市,这个技术文档工程师的平均工资偏低了。当然,文章也说明了这只是一个基于Fenzhi.com上数据的调查结果,样本为102个,并没有对地域和文档工程师的经验等因素进行区分,大家参考一下吧。

以下内容引用自该文章:

...