如果技术作家失踪了怎么办

在此博客中,我们多次提到,许多人对技术作家的工作一无所知。 老实说,文档团队可能被低估,甚至被低薪。

当然,整个技术交流者团体正在尽最大努力使全世界了解他们的专业,他们在生产和支持过程中的重要作用。 但是,技术写作的作用真的那么重要吗? 为了共同解决这个问题,我们决定邀请您与我们一起玩一些“假设”游戏。 如果所有技术作家一天都消失了怎么办。 不用说一句话或留下任何音符就进行“吹气”。 会发生什么事?

终端用户

想象一下,购买一台新设备,例如咖啡机或吸尘器。 并且,它没有用户手册。 或者,它有一个过时或写得不好的书,就像没有书一样糟糕。 当然,大多数此类家用设备都非常相似,并且由于您很可能以前已经拥有过咖啡机的使用经验,因此您可以推断出一些东西。 但是,只要这些设备在用途上相同,就可以在功能上有所不同。 因为他们的开发人员必须想出独特的功能,才能在竞争对手中脱颖而出。 无论如何,您可能会尝试联系支持服务,只是为了发现热线始终很忙-世界上有一半的人现在正在致电支持。

对于最终用户来说,这已经看起来很糟糕。 但这可能会变得更糟-可能根本没有真空吸尘器了。

生产

首先是问题-谁现在要编写文档? 人们可能会认为,支持将是完美的。 他们具有解释事物的经验,并且经常处理技术文档。

首先,您现在已经知道,客户的呼叫/消息将使支持越来越多。 其次,尽管支持团队成员通常会为知识库做出贡献并报告文档中的错误,但他们本身并不是作者。 问题是-创建用户手册并非易事。 您不仅需要完美的语法和常识。 您必须遵循特定的规则。 如果用户手册编写不当,可能会造成很多损坏。 我们在谈论金钱,财产,健康……这就是为什么,只有专业人员才能编写用户手册。

而且,生产可能会完全停止。 无法向每位新员工解释每一个与产品相关的细节。 而且,甚至不可能发布新的产品版本。 我们将花费数天和数周的时间培训每位员工!

顺便说一句,请看一下这篇文章,该文章描述了一名优秀技术作家的11项技能,成为一名技术作家也可能需要非常具体的心态和背景。

回到一切开始

在远古时代,人们一直在寻找将知识传给后代的方法。 长者经常会向年轻人传授他们所知道的知识。 但是,每次都必须重新解释一切都是很不方便的。 此外,人类在不断发展,他们的知识也在不断增长。

因此,产生了创建书写系统的需求。 当然,古老的书籍与现代的用户手册完全不同,您可能认为这个结论有些牵强。 但是,如果您考虑一下,技术文档实际上只是传承经验的一种方式。

答案可能简单吗?

没有技术作家,我们该怎么办? 我们可能可以尝试使UI和设备总体上不仅对用户友好,而且将其推向极致。 这样任何人都可以理解如何使用它们。 但是,有一个“但是”。

您是否看过电影“白专制”(2006年)? 这是一部科幻喜剧电影,向人们展示了未来的情况,即消费者除了消费外无需考虑其他任何事情。 是的,将“用户友好”发挥到极致。

例如,在医院的一个场景中,急诊室中的病人走到触摸屏上,看似幼稚的图画来选择疼痛的部位:腿,头,肚子……问题是-无论看起来多么简单,在内部,它仍然是一个非常复杂的机制,并附带了复杂的软件。 那需要维护。 反过来,如果没有技术文档,这是不可能的。 天哪!

结论

毫无疑问,没有技术作家的世界将是一团糟。 技术作家不断使所有人的生活变得更加轻松。 他们所做的工作看似看不见,但却对我们的世界产生了巨大的积极影响。

祝您在技术写作生涯中好运!
ClickHelp小组
跨平台和设备编写,托管和交付文档