应该认为技术写作很无聊

©Ugur Akinci

是的,应该进行技术写作

“无聊”意味着“零方差”

出现零方差时我们很无聊。 当事情没有改变。

好的技术写作每次对系统如何工作或如何完成任务的描述都必须零偏差。

例如 ,如果我们在第2页上将过程称为“子例程”,则必须在第34页上将同一对象称为“子例程”而不是“程序线程”,否则用户可能/将感到困惑并最终做错了事情。

想象一个飞行员……

想象一下,您的飞机是由一位飞行员驾驶的,他接受了非常“激动人心的”和“热闹的”培训手册的培训 ,该手册将提高飞机速度描述为一页上“踩油门”,另一页上“放开飞机”,另一个“将加油杆拉到位置X4”。

你相信那位飞行员吗? 我不会

技术写作的目的不是娱乐。

目的是教您如何以相同的方式每次都始终如一地解决问题,而不会出现任何错误。

为此,它必须是“坚硬的岩石”,这意味着它必须具有“ 零方差” ,根据定义,该零度转换为“ 镗孔”

悖论

但是编写任何一致且可靠的内容都需要大量的精力和创造力。

因此,这是“无聊的写作”的悖论 :要撰写无聊的技术文档,您需要大量的纪律,知识和创造力,以确保您所写的内容只能按预期的方式进行解释。

任何误解……都可能危及生命(例如,当飞行员因为在手册的不同部分中被称为“有趣的”名字而仅仅因为作者试图做到无聊而又“无聊”的操作而导致飞行员错开了开关时) 。

轶事

这使我想起了一个不同作家的轶事。

这位轶事作家坐下,给她的朋友写了一封很长的信。 在这封信的末尾,她添加了此便笺: “对不起,我今天没有时间给您写一封简短的信。”

经验丰富的技术作家总是会花时间编写无聊但正确而可靠的文档。

(照片由Fabrizio Bucella和Austin Neill在Unsplash-dot-com上提供)

©Ugur Akinci

附注:如果您愿意,可以考虑多次单击下面的拍手图标,以便更多的中级读者阅读。 谢谢。