最近和朋友聊天时，聊到了产品手册。想不到，这个话题就像被打开了闸门一样，让她忍不住一顿吐槽，滔滔不绝……
这位朋友是做产品研发的。因为产品的特殊性，她经常需要四处寻找合乎要求的元器件。在这个过程中，最让她恼火的事情是：很多网站上找不到清晰、完整的产品信息，甚至完全没有任何产品信息（除了产品名称和头图照片之外）。
恼火的原因有两个：
-
没有足够的产品信息，她就不能判断这个元器件是否满足他们的要求。
只有在确定元器件符合要求之后，公司才能进行价格、供货量、交期等商务方面的考量。
-
打电话的时间成本比在网站上浏览产品信息要高得多。
如果网站上没有提供足够的产品信息，她就需要打电话联系厂家，获取详细的产品资料或口头咨询。
如果一番折腾之后，元器件正好符合要求还好；而如果折腾之后还不符合要求，那这搭进去的功夫可就算白忙了！
无独有偶，很多行业里的客户对供货商的第一波筛选都是“是否拥有完善的、易于获取的产品资料”。比如，仪器仪表、工业用控制系统、芯片、以及电气控制类器件等。
正因为如此，像西门子、ABB、施耐德等知名企业不仅提供优质的产品手册，还提供免费、公开的下载渠道。
然而由于资源限制和诸多顾虑，国内的工业制造类企业鲜少公开自己的产品手册。即使由于上文所述的原因，某些行业的企业网站上提供了产品手册的免费下载，但产品手册的质量也往往不尽人意。
本文针对产品手册中经常出现、却又易于忽略的现象，总结了七条黄金法则。每条法则都配有实例，现身说法。
只要多用一份心，真正将七条黄金法则则践行起来，你的产品手册一定会大有改观。效果立竿见影哦！
名称：能少则少
一个部件使用一个名称就够了。如果一会儿叫张三儿，一会李四儿，过会儿又叫王五儿了，用户看着会头晕。
如果一个部件确实存在多种叫法，使用最简单的、用户最常用的那个名称。
比如，手操盒上的显示屏在某厂家的产品手册里拥有的名称达5个之多。这些名称处于不同的页面，来回变换，眼花缭乱。
切换到用户视角，感受一下↓↓↓
句子：能短则短
句子越长，结构越复杂，阅读难度就越大。产品手册本身就够枯燥的了，咱就不要再人为地为用户添堵了，是吧（咱善良点儿）?
所以，无论是什么类型的内容，都尽量使用短句子。正确地使用标点符号，千万不要一段到底、一逗到底！
多么长叫长句子，多么短叫短句子呢?
按照 ASD-STE100 的要求，描述性段落里的句子长度不能超过 25 个单词（约 42 个汉字），操作说明里的句子长度不能超过 20 个单词（约 36 个汉字）。
| 信息类型 | 英文句长 | 中文句长 |
|---|---|---|
| 描述型段落 | ≤25 个单词 | ≤42 个字 |
| 操作说明 | ≤20 个单词 | ≤36 个字 |
一般而言，中英互译时，1 个英文单词大约相当于 1.8 个汉字。
如果句子长度超过这个标准，使用其他句型结构重写这个句子。如果无论怎样重写都不符合要求，就将它拆分成两个或更多个句子。
切换到用户视角，感受一下↓↓↓
仪表根据“曲线校准”时所测量的除盐水的吸光度与本次基线校准测量的除盐水的吸光度的差值来平移坐标系。（49 个字）
曲线校准时，分析仪会测量除盐水的吸光度（$A_1$）。（23 个字）
基线校准时，分析仪会再次测量除盐水的吸光度（$A_2$）。（25 个字）
最后，分析仪根据两次测得的吸光度的差值（$A_1-A_2$）对坐标系进行平移。（31 个字）
操作说明：直截了当
操作说明是指完成一项工作或任务所需要执行的操作步骤。
操作步骤需要按顺序执行，不能颠倒，所以使用数字列表来编写操作说明。
操作说明中的每一个步骤，只能包含一项操作。有时，两个或多个操作必须同时进行。在这种情况下，可以把这些操作写在一个步骤里。
操作步骤必须使用祈使句来写。有些操作只在特定条件下才需要执行，也就是说这些操作说明带有条件从句。在这种情况下，条件从句写在前面，操作说明写在后面，二者之间使用逗号分隔。
很多手册里的操作说明写在普通段落里，使各项操作混杂在一起。这种写法不仅让用户搞不清楚各项操作的先后顺序，还容易产生歧义。
切换到用户视角，感受一下↓↓↓
称取 0.410g 硫酸联氨（$N_2H_4·H_2SO_4$），溶于已加有 74mL 浓盐酸的 500mL 试剂水中，转入 1L 容量瓶中，用高纯水稀释到刻度。
问题 1：根据“原文”中的描述（加粗部分），你认为盐酸溶液的体积是多少? 500 毫升，还是574 毫升?
- 量取 500 毫升试剂水。
- 向试剂水中加入 74 毫升浓盐酸，制成盐酸溶液。
- 称取 0.410 克硫酸联氨（$N_2H_4·H_2SO_4$）。
- 将硫酸联氨加入盐酸溶液中，并使其充分溶解。
- 使用高纯水将溶液稀释至 1 升。
- 将溶液倒入容量为 1 升的容量瓶中。
- 向溶液中加入高纯水，直至液面与容量瓶的刻度齐平。
问题 2：根据“优化后”中的描述（加粗部分），你认为盐酸溶液的体积是多少? 500 毫升，还是574 毫升?
安全说明：醒目庄重
安全说明在工业产品的产品手册里至关重要。它不仅是厂家应尽的法定告知义务，更关乎用户的人身安全和财产安全。
在产品手册里，必须为每一条安全说明划分等级。安全说明的等级划分规则必须在产品手册的“前言”里明确说明。
根据是否可能造成人身伤害、是否可能造成财产损失，通常可以将安全说明分为两大类：警告和注意。
| 安全等级 | 风险说明 |
|---|---|
| 警告 | 如果不采取措施，将会或可能会造成人身伤害。 |
| 注意 | 如果不采取措施，将会或可能会造成财产损失。 |
你还可以根据可能造成人身伤害的程度、可能造成财产损失的程度，进一步将安全说明细分为更多等级，比如危险、警告、小心、注意。
在产品手册里，安全说明必须设置为醒目的格式。为此，你还可以为每一条安全说明添加一个合适的图标。比如：
| 通用图标 | 激光图标 | 电击图标 |
|---|---|---|
 |
 |
 |
如果产品手册里的安全说明夹杂在普通段落里或者操作说明里，用户将很难注意到它们。
因为没有谁会去完整地精读一本产品手册。即使真读了，也很难倒背如流。没有醒目的格式或标志，真到用时只怕是要么没看到、要么打着灯笼也找不到吧?！
道理虽显而易见，但还真有不少厂家就是这样反其“道”而行之的……
切换到用户视角，感受一下↓↓↓
机床参数配置菜单用来设置机床硬件相关参数。由机床设备制造商根据设备型号来设置，设置完成后如机床硬件、电器参数无变化不需修改；机床使用用户如需修改该参数，请咨询设备制造商，在厂商技术工程师的指导下进行修改。
机床参数配置菜单里包含与机床硬件相关的参数。
机床参数配置菜单里的参数由机床设备制造商在出厂前完成预设，不需要频繁修改。只有机床硬件或电气参数发生变化时，才有可能需要重新设置这些参数。
如果您是机床设备的用户，切勿擅自修改机床参数配置菜单里的参数。参数配置错误可能导致机床不能正常工作！
如果确需修改，请联系您的机床设备制造商。机床参数配置菜单里的参数只能在机床设备制造商指定的专业技术人员的指导下进行修改。
段落描述：层次分明
任何产品手册里都缺不了段落描述。在产品概述、概念介绍、工作原理等章节里，段落描述是使用最多的文字组织形式。
段落虽然最为常见，但要写出主题鲜明、逻辑清晰的段落却不是一件容易的事。甚至可以说，在技术文档写作中，段落描述是最难写、最具有挑战性的部分。
按照 ASD-STE100 的要求，每个段落能且只能包含一个中心思想（主题），段落的长度不能超过 6 个句子。
段落中的句子尽可能使用主动语态。当然，别忘了上文里已经说过的短句原则 —— 段落中句子长度不能超过 25 个单词（约 42 个汉字）。
段落与段落之间、句子与句子之间使用关键词和连接词进行起承转合，使整个章节条理清晰、逻辑合理。
上文中，句子：能短则短中使用的句子，其实只是某个段落描述中的多半句话（不足一句）。现在，我们就来看看完整的段落吧！
切换到用户视角，感受一下↓↓↓
基线校准的主要作用是校正仪器的电气漂移、光学漂移和温度漂移，以保证测量数据的准确性。仪表根据‘曲线校准’时所测量的除盐水的吸光度与本次基线校准测量的除盐水的吸光度的差值来平移坐标系，保证测量的有效性和准确度。
基线校准是指校正分析仪的电气漂移、光学漂移和温度漂移。
分析仪在日常使用过程中，有可能会产生电气漂移、光学漂移或温度漂移。这些漂移会对测量结果的准确性产生微小的影响。基线校准通过校正这些漂移来提高测量结果的精度。
曲线校准时，分析仪会测量除盐水的吸光度（$A_1$）。基线校准时，分析仪会再次测量除盐水的吸光度（$A_2$）。最后，分析仪根据两次测得的吸光度的差值（$A_1-A_2$）对坐标系进行平移。
优化后的内容分为三段。每一段的中心思想（主题）依次是：
- 什么是基线校准?
- 为什么要进行基线校准?
- 怎样进行基线校准?
表格：择机而用
与大段文本相比，表格可以让内容一目了然，便于查找。所以，不要放过任何一个可以使用表格的机会！
一般而言，产品的技术参数、包装清单等与数据有关的内容都适合做成表格。除此之外，如果你发现某段文字里的句子句式简单、结构相似，写起来还感觉特别啰嗦，那么它很可能适合做成表格。如果被你遇到，不妨尝试一下！试试又不花钱，对伐?
如果要发布手机适配的在线文档，表格的总列数不要超过三列，而且每一列中不能包含过多的文本。否则，表格在手机屏幕上显示时容易出现错乱、变形。
切换到用户视角，感受一下↓↓↓
RichAuto 控制系统包含以下配件：手持运动控制器一个、线路转接板一个、两头榫式 50 针数据传输电缆一根、USB 通讯电缆一根。
收到 RichAuto 控制系统后，请按照包装清单（见表 1-1）检查包装内的物品是否齐全、完好。如果发现遗失或破损，请马上联系我们。
表 1-1：包装清单
名称 数量 备注 手操盒 1 — 线路转接板 1 — 数据传输电缆 1 50 针，两头榫式电缆 通讯电缆 1 USB 接口
列表：审时度势
列表可以直观地展现并列关系。如果段落中含有并列关系的句子或词语，可以考虑将他们写成列表。比如，产品特性。
如果列表中的项目不区分先后顺序，使用项目符号列表。如果列表中的项目有先后顺序，使用数字列表。
切换到用户视角，感受一下↓↓↓
系统提供了三种手动运动模式：连续、步进和距离。
在手动模式下，机床的运动轴有三种运动模式：
- 连续运动模式
- 步进运动模式
- 距离运动模式
结语
临阵磨枪，不快也光。文中的七条法则着重于快速改善产品手册的局部质量，一段话、一句话或一个词。
除了文字细节之外，编写产品手册的过程中还要考虑合规性、技术插图、导航设计、多设备适配性和版本管理等诸多方面。
所以才会流传这样一种说法：没有人愿意为产品写文档（因为 写文档太难了），也没有人愿意使用没有文档的产品（别人家的产品没有文档怎么行）。
如果想让产品手册的质量获得全方位提升，赶快去下载那些 全球大厂的技术写作指南们 读一读吧！
对于工业产品而言，以下三本指南一定要好好看看：
- ASD-STE100
- IBM 技术写作指南（骨灰级教科书）
- 微软技术写作指南
