技术写作¶
| date: | 2018-03-10 10:20 |
|---|
写作对大家来说并不模式，我们每天都会有很多写作任务，根据目的和读者的不同，常常有如下分类：
- 创意写作（ Creative Writing ），打动人的心灵
- 文案写作（Commercial copy writing)，卖东西
- 商务写作（Business writing)，管理人员
- 科学写作（Scientific writing)，记录和分享科学发现
- 技术写作 (Technical writing)，解释工作原理、指导用户完成特定操作
技术写作伴随着工业时代而产生，随着设备越来越复杂，以及机械设备的全球使用，提供各种技术资料的形式帮用户使用文档是非常常见的。在新媒体时代到来之前，通过文字的形式给用户提供帮助是最常见的形式。即便是今天，考虑到信息的可即性(Accessbility)，传统的说明书依然是各类产品的标配，各类产品标准中也都会相应的规定。
首次使用¶
和有经验的用户相比，首次使用的用户需要更多信息和指引。你需要了解需要做什么，哪些不能做，以便能正确进行操作。尤其是以前没有用过的产品，例如刚买的空气净化器如何安装和启动等。技术写作人员需要构思如何提供必要的信息，全部提供，新手需要阅读太多内容，甚至因为信息过载(information overload)而直接放弃操作。提供的信息太少，不足以让用户完成任务。
针对首次使用的用户设计信息听起来容易，实际上很难。很难有同理心(empathy)是其中很重要的问题。文档工程师常常参与整个产品研发，产品开发完后，文档工程师对产品已经很熟，已经很难将自己想象为首次使用的用户。甚至会觉得：“很显然，大家都应该明白。”一旦开始这样想时，常常文档就会变得很难用了。
注解
补充信息 首次使用手册中常常需要包含的信息 1. 设计用途和产品局限 2. 零件和控件的名称以及位置 3. 安装、启动、操作、关闭和维护的详细操作步骤 4. 产品使用可能造成伤害的安全和警示信息 5. 故障排除信息和维修步骤 6. 制造企业的联系方式
持续的参考¶
用户在使用过程中常常会遇到很多问题，或者是需要了解更多信息。技术文档便可提供持续的参考。相信大家也经常看到说明书封面上印有：“妥善保存，以备后用”等字样。例如购买了自来水过滤器，使用一段时间后系统提示需要更换滤芯，这类信息用户在使用过程中才会遇到。
如何组织和安排这类信息也非易事。用户类型千差万别，使用过程也是五花八门。如何预测用户的信息需求，并组织信息便于查找。如果信息不好找，用户可能：
- 直接放弃使用
- 直接自行尝试解决
- 联系厂商来解决