站上的技术文章不是写完就发。每一篇都要过一遍内部审稿,被退回是常有的事。回头看,退回的原因集中在三类,而且都不是文笔问题。这篇文章把这三类问题写出来,一是因为它们最常见,二是因为外部读者往往看不出来。

第一类:数据没有出处

最常见的情况是数字写得很具体,但追不到来源。比如写某个参数时用了别的机型的口径,或者把系列里的某一个值当成了整系列的值。处理办法是把每个数字退回原始资料:参数表、检测记录或者标准文本,核对口径一致再写回正文。

参数表的写法上有一个容易出错的地方:区间值不能变成单值。ZYD-100 的工作真空度是 -0.08 ~ -0.0999 MPa,含水量是 ≤3 ppm (GB/T 7600),含气量是 ≤0.01% (GB/T 423),击穿电压是 ≥65 kV (GB/T 507),清洁度对应 NAS 1638 5 级,过滤精度是 ≤1 μm。这些数字带上原来的限定符号和标准号一起写,才是对的;写成某一个具体读数,就成了另一个意思。

第二类:标准号被顺手写上

写油品检测内容时,最容易发生的情况是正文提到了某项指标,顺手把一个标准号写上去。这个习惯看起来无害,但标准号是有约束力的,它意味着按这个方法测、按这个判定。写标准号之前要确认两件事:这次检测确实按这个标准执行,判定阈值也确实取自这个标准。

另一个相关的问题是标准号写对了,判定阈值却是别处的。GB/T 7600、GB/T 423、GB/T 507、NAS 1638 各管各的指标,标准号和阈值要成对出现,不能拆开引用。检查的时候把两者放在一起看,比单独核对标准号更可靠。

第三类:结论写成了推荐

给出适用条件是技术文章应有的写法,但有时候写着写着就变成了推荐。判断标准很简单:文章说的是在什么条件下选什么、会出现什么现象、应该怎么判断,而不是哪一种做法更好、应该买哪一台。

改稿的时候,把推荐语气改回条件句,往往只需要换掉几个词,但结论的性质完全不同。比如把设备在特定工况下的表现写成普遍结论,就是越过了边界。

车间内的滤油设备整机与管路布置
照片要能说明问题:设备结构、接口位置或者现场状态,泛泛的整机照帮不上忙

审稿时具体查什么

  • 每一个数字都能指回原始资料,口径与机型一致,区间没有被写成单值。
  • 标准号与判定阈值成对出现,标注的是实际执行的方法。
  • 结论写成条件而不是推荐,没有出现排名、份额、客户名称和获奖记录。
  • 参数与机型的对应关系没有串位,系列值没有张冠李戴。
  • 图片能说明正文在讲的东西,图片路径与实际文件一致。

为什么要保留这道流程

一篇技术文章发出去之后就会被引用、被截图、被当成依据使用。一个写错的数字流传出去,纠正的成本远高于写的时候核对一遍。文章的价值建立在每个数字都对得上这一点上,审稿流程就是为这个价值存在的。

文章写完不等于完成,能把每个数字指回原始资料,才算写完。