为什么你应该考虑从事技术写作

技术写作是什么和它是如何不同于其他类型的内容?高级技术作家东北女校友凯特·施耐德狂妄的软件,解释道。

---

嗨,我的名字是凯特和我是一个技术作家。

我习惯于瞪了他一眼,当我告诉人们我的职业。”一个技术作家吗?“他们问。“那是什么?”

“嗯,我编写软件程序的方向。所以每当我的用户需要帮助,他们点击“帮助”按钮,阅读我的写作。如果您曾经使用过帮助单词之类的,是像我这样的人写的。”

(这就是我瞪了他一眼。)

“哦。我从未意识到,有人写了这些东西。”

我经常笑,让一些自嘲的笑话。是的,我写的东西。和我爱它。

技术作家做什么工作?

简单地说,技术作家解释事情。我们把复杂的概念和分解成易于理解的部分。我们也擅长组织信息所以流逻辑。使用这些技能,技术作家通常负责多种写作:手册、在线帮助系统,甚至视频教程。

它是如何不同于其他类型的写作?

我有很多不同的工作,我写很多不同的东西:建议、报告、新闻稿、和营销的浮油。我写的文档作为一个技术作家非常不同于所有这些其他类型的写作。

首先,技术文档通常是主要集中在步骤和流程,精心组织。这种对细节的关注和组织使得你很容易找到你需要做什么,做它,继续你的一天。技术文档的主要目的是帮助你了解你需要知道。

第二,技术文档通常是非常直接的。你不会找到任何额外的绒毛在在线帮助系统(虽然技术作家喜欢用例子来说明概念)。相反,我们开门见山地告诉你你需要知道的所有警告和警告将会帮助你。

第三,虽然直接,技术文档也很详细。虽然报告或建议可能给出一个“30000英尺的概述”的话题,没有足够的技术文档。一个技术作家,更多的信息在你的文档中,越好。通过了解我们的产品和解释一切我们可以,我们帮助我们的读者理解产品和学会正确地使用它。你能想象如果飞机手册只给了一个简短的概述如何操作一架飞机吗?

那你为什么这样做?

有时当我瞪了他一眼,人们问我为什么我做我做的事。好吧,我爱我的工作,因为技术作家是在幕后,帮助人们,当他们需要它。当你建立你的咖啡壶,一个技术作家写了这些指令。当一个飞行员安全检查飞机,一个技术作家写道,手册。当你浏览互联网上对一个问题的答案和找到一些产品常见问题或在线帮助,一个技术作家写道,内容。

所以下次你安装新软件在您的计算机上,遇到一个错误,或者你可以不记得如何设置一个Microsoft Excel宏,请单击帮助图标和搜索文档。别人写的东西,我们这样做是因为我们想帮助。