【案例分享】文档写作工具选型 I
2021-02-04 本文已影响0人
Joy的未来十年
近期启动写作工具选型项目，用此文记录我在选型使用过程中的体验，借此厘清思路，也给大家提供借鉴；同时，欢迎有经验的同行提供建议。新入行的朋友，可以通过此文对文档写作工具有一个全面的了解，并跟随我体验最新的Cloud-based写作与内容管理平台。
项目介绍
现状
| 类别 | 描述 |
|---|---|
| 公司规模 | 100人以内小型公司，压缩空气测量与监控仪器仪表与软件研发与生产 |
| 产品 | 五个产品类别，其中四类为智能仪器仪表，一类为监测与分析软件。每类有近十种产品 |
| 当前写作工具 | 开源LibreOffice/OpenOffice （类似于MS Word） |
| 存在问题 | * 无法做到Content reuse。同系列产品手册有一定相似度，增加了TW的工作量，并且修订过程易出错，影响文档质量。在OEM产品发货时，手册有换logo/公司名的需要。 |
| * 手册的发布格式单一：PDF文件打印随产品发货，可放在网站上供下载。需要顺应手机网络时代，在网站上提供HTML文档供用户下线查阅与commenting。 | |
| * 产品经理参与手册写作与审阅，他们地理上分布在欧洲与中国各地。目前工具无法做到协同写作与审阅，效率低下。 | |
| * 没有自动化的版本控制机制，影响到了翻译的效率。 |
工具需求
- Collaborative writing and reviewing
- Content reuse ( To reuse text- and image- by using condition-sensitive text, varables, and snippets)
- Single-source authoring with multiple output formats (html for website publishing and pdf for traditional publishing)
- Cloud-based S/W but with comfortable connection speed as low speed negatively impacts the writing experience! This is very important for a writer.
- Version controlling for notifying reviews and translators of the revision history, making them track changes easily. (CMS integration is needed.)
- PDF output to have almost the same looks as a WORD file can do.
- Affordable price for small-sized company.
调研
文档写作工具的趋势与分类
Joy: Web-based authoring tools便于协同开发与评审文档。
Adobe 2020年技术文档趋势调研 > Web-based authoring
Joy: Style-based authoring tools包括Word, Libre/OpenOffice, WPS...
Adobe 2020年技术文档趋势调研 > Content Writing Formats
Joy: Style-based authoring tool仍是主流；企业规模越大，HTML-based authoring tool的份额被DITA-based XML authoring tool取代的比例就越大。
Adobe 2020年技术文档趋势调研 > 企业规模对结构化写作工具选用的影响
Joy: 从获取用户反馈的角度来看，内容以HTML网页形式放置在网络上（如公司网站），最具优势。
Adobe 2020年技术文档趋势调研 > 读者反馈
三类写作工具的优劣势比较
以下是Paligo的一篇公关博文（https://paligo.net/blog/single-sourcing/efficient-technical-documentation-why-you-need-to-separate-content-and-layout/），文中用实例清楚的阐明了上述三种写作工具在Separating content and layout方面的优劣势。
无疑：XML-based authoring tool最具优势，最灵活。
但，对于中小型公司，性价比不高，工具的灵活性与丰富功能，未必有资源去挖掘与使用。我并不倾向于使用XML写作工具，原因如下：
- 成套软件价格高 （特别是集成了CCMS系统），中小企业需要的在价格与灵活性上折衷的工具。
- 对Writer素质要求高，TW需要熟悉并熟练应用XML elements。而对于专业性强的用户文档，通常产品经理会参加文档写作或是初稿由产品经理完成，要求产品经理使用XML进行写作，不现实。
Cloud-based工具：为中小企业带来曙光
经过一段时间的调研与试用，惊喜的发现Web-based的写作工具正借助云技术，为中小企业提供了一套集写作、内容管理、评审、翻译、发布portal于一体的Cloud-based写作平台。
最近，我试用了两个这样的工具。将在II 中(https://www.jianshu.com/p/d4996eddb380)，介绍对比与心得。
相关文章：
【经验谈】技术文档常用写作绘图工具
