Archive for the ‘TC沪联’ Category

Technical Writer 与开发测试的人员比例

2013年8月1日

Technical Writer (技术文档工程师)已经成为很多公司产品研发团队的组成部分之一。

那么,技术文档工程师与开发测试工程师的人员比例大概是怎么样的呢?是不是有一个比较合理的人员配比?

说实话,这很难有一个统一的答案。由于行业、产品和项目的不同,对技术文档工程师数量的要求可能也会各有不同。

下面给出的人员比例,主要是根据与前辈和同行的交流以及自己的个人经验总结出来的,比较主观,而且主要针对软件行业。

...

Madcap Flare 文档 Samples

2013年7月30日

由 Madcap Flare 输出的文档是最终是什么样的?

下面的链接展示了一些公司的在线文档,都是使用 Flare 作为文档写作工具输出的。

想要了解 Flare 或者想看看其他公司的用户手册或在线帮助长什么样的同学,可以去逛逛。

...

[Webinar] Improving Service Delivery by Making Technical Documentation Interactive

2013年7月25日

Interactive Document,这不是一个新概念。互动性良好的文档,可以提高用户体验。

Oberon Technologies 公司的 Joe Jenkins 在 2013 年 7 月 20 日的一次 Webinar 里对文档的互动性进行了探讨。

...

网站增加论坛功能

2013年7月24日

这两天看到网站空间有mySQL数据库的赠品,于是心血来潮决定在网站增加一个论坛功能。

初衷一方面是免费的空间赠品不用白不用,另一方面是希望可以提供一个供Technical Writers交流讨论的空间。或许你的问题其他的同行有办法解决,又或许你可以给其他人提供帮助。

...

孚为信息招聘 Madcap Flare 培训师

2013年7月22日

上个星期才从朋友那里听说孚为信息成为美国 Madcap 软件公司在中国区指定授权经销商之一,今天就偶然看到了他们在招聘 Madcap Flare 培训师。

在这里转发一下这则招聘信息吧。

这个职位的定位是 Madcap Flare 培训师、企业技术文档解决方案咨询及销售顾问。

对于 Technical Writer 来说,这样的机会还是蛮少的。想挑战新工作内容的 Technical Writer,可以试试。

招聘信息如下:

...

文档中 Copyright 的意思和正确写法

2013年7月20日

在所有对外发布的技术文档中,一定都会有 Copyright。作为技术文档工程师,在我们需要加入或修改版权信息的时候,可能大都是从模版或者以前的文档中拷贝过来,然后修改一下时间。

那么,这个 Copyright 是什么意思,我们是不是清楚它的正确写法呢?

在这篇 Blog 里介绍和记录一下吧。

...

中国技术写作调查 (Survey on Technical Writing in China)

2013年7月17日

首先,要感谢阿媛组织了这次中国技术写作调查,并进行了全面的统计分析。因为她,才有了这次博客分享。

这是我所知道的对中国技术写作从业者最全面和最有针对性的调查了。个人认为调查的结果还是很有参考价值的。

截止到最近一次统计,总共有35名技术写作从业者参加了调查。

调查的内容包括技术写作从业者的行业、职位、性别、地域、经验、写作语言、以及工资待遇等方面。

下面就是目前最新的调查统计结果,供大家参考:

...

Flare 输出包含超大表格的 PDF

2013年7月12日

最近做的一个项目需要在Flare(Version: 9.0)里加入一个将近6000行的超大表格并输出PDF文件。结果发现Flare在处理超大表格时速度非常慢,有点处理不了的感觉。

首先,我需要把这个表格从Excel里面复制过来,粘贴到Flare的Topic文件里,然后进行简单格式调整。在这个过程中,Flare就已经Crash了好几次……

好不容易把表格在Flare里面调整好了,于是开始输出pdf,让人更痛苦的事情发生了:

在我的机器上(4G内存),Paginating了将近十个小时都没结束,风扇狂转,只好放弃。找了同事更好的机器(8G内存)帮忙,Paginating在几个小时后结束,然后分页输出竟然是以每小时25页的龟速进行。

怎么办?这可是将近400页的文档啊……要等多久啊……项目就要递交了……

...

每个公司都需要自己专有的 Writing Style Guide 吗?不!

2013年7月2日

每个公司都需要Writing Style Guide来规范技术写作吗?
Dan:嗯,我认为是的。一个公司的技术文档,特别是面向客户的 产品文档,很大程度上体现了一个公司的专业性。如果没有一个统一的Writing Style Guide作为指导,不同的技术文档作者在写作的时候就没有统一的规范,也就不能保证写作风格的一致性。最终呈现在用户面前的就可能是一份格式和表达不 一,显得很不专业的产品手册。如果是几个作者合作同时为一个产品开发文档,就更需要有一个Writing Style Guide来进行规范了。

那么,每个公司都需要编写和维护属于自己公司的Writing Style Guide吗?
Dan:这个……我觉得,不需要。

为什么呢?前面不是说Writing Style Guide很重要吗?

...

STC,你加入了吗?(2)

2013年6月21日

继续聊聊STC。

STC现在有多少中国同行加入呢?

据我个人的不完全统计(按国家搜索好友),当前来自中国的STC会员人数为12人。

有图有真相:

...