这两天有读者来信问到技术文档写作需要使用什么工具,正巧孚为信息最近也公布了他们前段时间组织的一次关于技术写作工具调查的结果。这个结果和我回复那位读者时所提到的工具是基本一致的,这里就借用一下调查结果吧。
一共有 62 人参加了此次调查,调查结果一定程度上反映了目前各种技术文档写作工具在国内公司中使用的普遍程度。
主要结果如下:
...
这两天有读者来信问到技术文档写作需要使用什么工具,正巧孚为信息最近也公布了他们前段时间组织的一次关于技术写作工具调查的结果。这个结果和我回复那位读者时所提到的工具是基本一致的,这里就借用一下调查结果吧。
一共有 62 人参加了此次调查,调查结果一定程度上反映了目前各种技术文档写作工具在国内公司中使用的普遍程度。
主要结果如下:
...
由于公司的 Online Help 将要逐渐加入视频内容,大家也开始更多地学习和使用 Camtasia Studio。
这个工具确实是制作 How-to 视频的利器,熟悉以后可以很方便地制作出视频教程。
...
Technical Writer (技术文档工程师)已经成为很多公司产品研发团队的组成部分之一。
那么,技术文档工程师与开发测试工程师的人员比例大概是怎么样的呢?是不是有一个比较合理的人员配比?
说实话,这很难有一个统一的答案。由于行业、产品和项目的不同,对技术文档工程师数量的要求可能也会各有不同。
下面给出的人员比例,主要是根据与前辈和同行的交流以及自己的个人经验总结出来的,比较主观,而且主要针对软件行业。
...
Interactive Document,这不是一个新概念。互动性良好的文档,可以提高用户体验。
Oberon Technologies 公司的 Joe Jenkins 在 2013 年 7 月 20 日的一次 Webinar 里对文档的互动性进行了探讨。
...
在所有对外发布的技术文档中,一定都会有 Copyright。作为技术文档工程师,在我们需要加入或修改版权信息的时候,可能大都是从模版或者以前的文档中拷贝过来,然后修改一下时间。
那么,这个 Copyright 是什么意思,我们是不是清楚它的正确写法呢?
在这篇 Blog 里介绍和记录一下吧。
...
上一篇文章谈到了 Structured Authoring,什么是 Structured Authoring?
这里推荐 Sarah O'Keefe 写的一篇 Whitepaper,写得很详细。除了 Structured Authoring,这篇 Whitepaper 还对 XML 进行了介绍。
...
Structured Authoring,几乎所有业内人士在介绍技术写作趋势的时候,都会提到“她”。
她,真的有那么好吗?
上个月Tom Johnson发表了一篇名为"Is Structured Authoring (like DITA) a Good Fit for Publishing on a Website?"的博文,Tom 列出了Structured Authoring对于Web的各种不适应。这篇文章引发了美国技术写作圈子的热烈争论,不少业内人士都进行了回复,表达自己的观点。其中Sarah O'Keefe还在自己博客中剑拔弩张,针锋相对,对Tom的观点逐一进行反驳。
...