大家在完成文档的 Draft 之后,如何进行文档 Review,收集反馈呢?
用邮件给相关人员发 PDF 文件应该是对文档进行评审并收集文档反馈的常用方式之一吧 (当然,还有召开 Review meeting 等其他方式)。
在发出 PDF 之后,如果文档的评审人员很多 (wide audience review),你是不是也有过被反馈邮件搞得晕头转向的时候?
...
大家在完成文档的 Draft 之后,如何进行文档 Review,收集反馈呢?
用邮件给相关人员发 PDF 文件应该是对文档进行评审并收集文档反馈的常用方式之一吧 (当然,还有召开 Review meeting 等其他方式)。
在发出 PDF 之后,如果文档的评审人员很多 (wide audience review),你是不是也有过被反馈邮件搞得晕头转向的时候?
...
如果自己不是技术文档工程师,大概也不会想到一个小小的技术文档写作领域,居然有这么多的技术写作工具可供选择。
随着 Software as a Service (SaaS) 的流行,技术文档写作工具是否也会开始云端化?
...
这两天有读者来信问到技术文档写作需要使用什么工具,正巧孚为信息最近也公布了他们前段时间组织的一次关于技术写作工具调查的结果。这个结果和我回复那位读者时所提到的工具是基本一致的,这里就借用一下调查结果吧。
一共有 62 人参加了此次调查,调查结果一定程度上反映了目前各种技术文档写作工具在国内公司中使用的普遍程度。
主要结果如下:
...
由于公司的 Online Help 将要逐渐加入视频内容,大家也开始更多地学习和使用 Camtasia Studio。
这个工具确实是制作 How-to 视频的利器,熟悉以后可以很方便地制作出视频教程。
...
由 Madcap Flare 输出的文档是最终是什么样的?
下面的链接展示了一些公司的在线文档,都是使用 Flare 作为文档写作工具输出的。
想要了解 Flare 或者想看看其他公司的用户手册或在线帮助长什么样的同学,可以去逛逛。
...
最近做的一个项目需要在Flare(Version: 9.0)里加入一个将近6000行的超大表格并输出PDF文件。结果发现Flare在处理超大表格时速度非常慢,有点处理不了的感觉。
首先,我需要把这个表格从Excel里面复制过来,粘贴到Flare的Topic文件里,然后进行简单格式调整。在这个过程中,Flare就已经Crash了好几次……
好不容易把表格在Flare里面调整好了,于是开始输出pdf,让人更痛苦的事情发生了:
在我的机器上(4G内存),Paginating了将近十个小时都没结束,风扇狂转,只好放弃。找了同事更好的机器(8G内存)帮忙,Paginating在几个小时后结束,然后分页输出竟然是以每小时25页的龟速进行。
怎么办?这可是将近400页的文档啊……要等多久啊……项目就要递交了……
...
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的观点逐一进行反驳。
...
前两天才在博文里面说到HyperSTE集成到Madcap Flare可以高效的进行术语管理,更好的统一文档中用词和表达,本来还想着什么时候去尝试一下,而今天就看到了在June 20, 2013有一个由Etteplan 和Madcap主办的免费的Webinar。
自己已经注册了,希望到时候可以有时间去听听。不知道HyperSTE是不是真的可以方便的将一个公司自己的术语库或是writing styles导入工具。
下面是这次Webinar的主要内容:
...