他们在技术作家学校不教的事情

在正式的技术写作学位课程开始之前,我是从技术作家开始的。 虽然大学为我奠定了坚实的基础,但我今天所学的很多东西都是通过实际工作中学到的。 不管教授怎么说,没有什么可以替代实际参加工作的。

虽然我很少再与初级技术作家合作,但我有很多机会与非作家合作处理文档。 这让我开始思考我在工作中所学到的与在学校所学到的。 大学毕业后,我必须学习了解组织动力和人员技能。

这是他们在技术作家学校不教(但应该)的一些事情:

程序员是懒惰的(但是很好)

如果我愿意的话,我会一直与程序员一起工作,因为我的某些绝对职业生涯的重点是直接与软件开发团队合作。 他们很懒。 但是以正确的方式提醒您。 他们中的许多人重用代码和使用快捷方式的方式应该成为我们其他人(主要是技术作者)的模型。

遵循“程序员懒惰”模型,技术作家还可以通过研究同一程序中的相似项目来了解程序元素。 尽管对于某些人来说这是一个简单的概念,但我遇到了一些从未考虑过这种角度的人。 理解程序员的工作方式,包括他们如何设计和实现程序功能,可以通过缩短他们在新项目上的学习曲线来极大地帮助技术作家,并帮助他们在整个开发过程中做出更大的贡献。

Microsoft Office并不总是按广告宣传工作

作为一名技术作家,您可能需要花费更多的时间才能使Microsoft Office应用程序如所宣传的那样工作,特别是如果您偶然发现了一个粗俗的实现。 这意味着,Microsoft Office故障排除技能的一小部分可以帮助技术作家发挥作用,特别是如果服务台更着重于关闭Remedy票证而不是实际解决用户问题时。

技术作家需要掌握他们所写的概念

尽管技术作家不必是技术专家,但他们确实需要能够学习新的软件和技术概念来编写文档。 如果技术作家依靠中小企业的草稿来开展工作,那么他们不是作家。 将其设置为技术文档现状的组织需要重新评估技术作家在其开发工作中的作用。

问题应针对性不广

只提出广泛的问题是浪费时间。 当您考虑技术作家可能会偶然发现某些项目要素时,团队其他成员尚未完全想到问题,问问题可能是一门艺术。 提出正确的问题可以帮助编写文档,尤其是当技术作家掌握了项目背后的技术时。

人为的信息壁垒只是一个邀请

如果在技术作家和信息之间设置了人为障碍,则应邀请技术作家来解决它。 这意味着技术作家需要一些人的技能,魅力和才能,才能在遇到这种情况时能够看到工作的角度。

会议纪要适用于吸盘

我对工作场所会议记录的看法已得到充分记录。 技术写作者切勿自愿参加会议记录或将其视为“内部密室”的“钥匙”。一旦程序员看到技术写作者进行会议记录,他们将自动等同于担任秘书。 担任秘书并没有什么错,但是技术作家需要与程序员坐在同一张桌子上,并且不要让自己被最小化为传统上非常非技术的职位。

尽管我欢迎正式的技术写作计划,但我从未真正信任过学术界,但希望这些计划能在现实中站稳脚跟,不要让学生的头脑在现实世界中没有直接应用的废话今天的。

学校还需要向准技术作家教授什么?


嗨! 我叫威尔·凯利。 我是华盛顿特区的技术作家和分析师。 我曾与NetApp,Dell和Neustar等客户合作开发技术,培训和思想领导力内容。 我的文章已由IBM Mobile Business Insights,TechBeacon,CNET TechRepublic,Toolbox.com,ZDNet.com等发布。 在Twitter上关注我: @willkelly