Archive for the ‘工具方法’ Category

从 DITA 的那只鸟谈起——DITA 特点浅析(一)

2016年3月24日

从事技术传播的同学对这幅图一定不会感到陌生。这是 Darwin Information Typing Architecture (DITA) 的 LOGO,而 DITA 是 OASIS 发布的一套关于如何编写和发布技术信息的标准。

注意到了这个 LOGO 里的这只鸟了吗?它可是大有来历的!

...

文档评审工具:Acrobat Shared Review

2015年4月14日

大家在完成文档的 Draft 之后,如何进行文档 Review,收集反馈呢?

用邮件给相关人员发 PDF 文件应该是对文档进行评审并收集文档反馈的常用方式之一吧 (当然,还有召开 Review meeting 等其他方式)。

在发出 PDF 之后,如果文档的评审人员很多 (wide audience review),你是不是也有过被反馈邮件搞得晕头转向的时候?

...

云上的技术文档写作工具

2013年11月5日

如果自己不是技术文档工程师,大概也不会想到一个小小的技术文档写作领域,居然有这么多的技术写作工具可供选择。

随着 Software as a Service (SaaS) 的流行,技术文档写作工具是否也会开始云端化?

...

XML 是如何变成 PDF 的?

2013年10月12日

在 Single Source 的技术写作中,XML(或 HTML)应该是最常用的源文件格式,而文档最终的输出文件,一般也总少不了 PDF 格式。

那么, XML 是如何转化成 PDF 的呢?

简单说来,通常我们只要在 Authoring Tools 里点击 Save as PDF,然后悠闲地喝上一杯咖啡,PDF 文件就到手了。

这个没错,不过这里是想聊聊在您喝咖啡的时候,程序在后台都做了哪些辛勤劳动为您生成 PDF 文件。换句话说,是想要介绍一下 PDF Formatting Tools and Solutions。

...

技术文档写作工具最新调查结果

2013年9月30日

这两天有读者来信问到技术文档写作需要使用什么工具,正巧孚为信息最近也公布了他们前段时间组织的一次关于技术写作工具调查的结果。这个结果和我回复那位读者时所提到的工具是基本一致的,这里就借用一下调查结果吧。

 一共有 62 人参加了此次调查,调查结果一定程度上反映了目前各种技术文档写作工具在国内公司中使用的普遍程度。

 主要结果如下:

...

Camtasia Studio 教程

2013年9月16日

由于公司的 Online Help 将要逐渐加入视频内容,大家也开始更多地学习和使用 Camtasia Studio。

这个工具确实是制作 How-to 视频的利器,熟悉以后可以很方便地制作出视频教程。

...

Madcap Flare 文档 Samples

2013年7月30日

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

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

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

...

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页的文档啊……要等多久啊……项目就要递交了……

...

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)的工具进行区分,榜单位置有限。

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

...

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功能,可以让文档和用户以及用户和用户之间进行互动,作者也可以及时了解用户对文档的反馈。

...