Archive for the ‘TC沪联’ Category

技术文档工程师将死?

2014年5月17日

技术文档工程师,似乎是一个还未好好发展的职业(特别是在中国),怎么会就要死去了?

别开玩笑了好不好。

说好的美好职业前景呢?

说好的企业会越来越重视文档所带来的价值呢?

其实我也不大相信。可是近来确实听到了一些不太和谐的声音,有来自我身边的,也有我在网上看到的。

先看看来自我身边的技术文档工程师(或前技术文档工程师)朋友们的一些声音:

...

言简意赅

2014年4月1日

言语简练,意思完整,这几乎是评判所有写作好坏的重要标准之一。

对技术文档工程师而言,言简意赅更是我们写作的努力方向。冗长的行文,拖沓的表达,不仅增加之后的翻译成本,更为重要的是,浪费了用户宝贵的时间和精力,从而让用户对文档甚至对产品留下不好的印象。

如何做到言简意赅?“The Elements of Style” 的作者 E.B. White 和 William Strunk Jr. 给一个很好的回答:

...

技术写作实战(5)

2014年3月29日

请按照技术写作的要求修改下面的句子:

  1. The default value of the <duration> parameter of this JS function is 100.
  2. Remove the selected record from the list by clicking Drop.
  3. You can create your maintenance plan with Schedule Editor.
  4. Enter the record number that you want to search for.
  5. Click on Next (or press on the Enter key).

...

IBM 技术文档的质量标准

2014年3月21日

IBM 作为一家高大上的 IT 公司,对技术写作领域的影响也非常大,比如 DITA,比如技术写作规范,比如对技术写作人才培养(仅在上海,IBM 就有几十名技术文档工程师),等等。

那么,IBM 技术文档质量标准是什么?来看看 IBM 是如何定义高品质的技术信息内容的吧。

IBM 的 Corporate User Technologies Team 将高品质的技术信息概括为三个方面:

...

技术写作实战(4)

2014年2月25日

请按照技术写作的要求修改下面的句子:

  1. The data integrity is checked by the scheduler.
  2. The following features can be found in this release.
  3. The error message can be removed by clicking Ignore.
  4. Verification of the digital signature is performed in the next step.
  5. Click Done
    The connection is now set up.
  6. The maintenance report is generated monthly.

...

Content Strategy 101

2014年1月25日

国外很多大学的课程都会在后面加上个 101,表示这是该专业或领域的入门课程。Content Strategy 101,自然就表示这是 Content Strategy 的基础知识。

...

如何写技术文档

2013年12月12日

偶尔看到一篇有趣的文章,诙谐地描述了技术文档的写作过程。

我相信在实际工作中并非都是这样的,但这确实是有可能出现的情况:由于程序员太忙、不重视、认为 TW 应该具备和程序员一样的技术水平等各种原因,造成 TW 很难获取撰写技术文档所需要的信息。

这时候 TW 应该如何应对,相信大家各有各的方法。

曾经有人建议过一个方法: 在无法获得信息的情况下,先尽自己的努力快速完成初稿,虽然写出来的东西可能连自己都看不下去,但重要的是先把初稿完成并发出去,之后就在被工程师不断鄙视的 Review 过程中,获得有用的信息,最终按时完成项目。

这是不是一个好方法,我不加评论。还是放松一下心情,看看下面的文章吧。

...

Technical Writers, 请好好准备我们的个人简历吧!

2013年12月2日

由于近来公司部门在招聘技术文档工程师 (Technical Writer),也看了不少想要入行或是想要换工作的候选人的简历,觉得有必要聊聊 Technical Writer 的简历问题。

个人简历,是用人单位了解候选人非常重要的途径之一。是否可以获得面试的机会,可以说很大程度上取决于我们的个人简历能否在第一时间打动招聘官。简历的好坏,对于在面试官心中建立怎样的第一印象起着至关重要的作用。

对于我们技术文档工程师来说,个人简历就更为重要了。这是因为简历本身就是你的写作作品,你的简历反映了你的写作能力和工作态度。如果连这么重要的简历,都能出现拼写和语法错误,或者是让人觉得敷衍了事,那么这就很难让人相信你会是一个合格的技术文档工程师了。

...

技术写作实战(3)

2013年11月29日

请按照技术写作的要求修改下面的句子:

  1. Do not turn off the computer when the application is still running. Doing so will stop all the tasks in process.
  2. This section will describe the configuration parameters.
  3. When the function returned a value, the loop escapes.
  4. When the function returns a value, the loop will escape.
  5. Enter all the required information, and then click Next. The confirmation screen will display.
  6. The following defects were fixed in this release.
  7. If you selected Reset in the previous screen, the current screen displays the default settings.

... 

北京大学第二届技术传播与技术写作沙龙

2013年11月11日

北京大学语言信息工程系,将联合中国标准化协会于 2013 年 11 月 29 日在北大举办第二届“技术传播与技术写作沙龙”,诚挚邀请各界同仁参加本次“技术传播与技术写作”沙龙,共同探讨行业发展问题。

北京不愧是文化中心,学术氛围好;北大的语言信息工程系也在技术传播与技术写作领域的人才培养上走在了各大高校的前头。

...