摘要
- Uber 工程团队中的技术作家
- 技术作家究竟做什么？
- 技术作家最大的挑战是什么？
- 关于技术写作最大的误解是什么？
This article is part of an Uber Engineering tutorial series. Make sure to check out my other articles as well:
Uber 工程团队中的技术作家
在本文中，Uber 前实习生 Shannon Brown 介绍了她作为技术作家的工作情况，并回答了 Uber 工程团队中有关这一重要角色的常见问题。
- 原标题：Seven Things to Know about Technical Writing at Uber
- 链接：https://eng.uber.com/technical-writing-uber
- 作者：Shannon Brown
- 发表时间：October 3, 2018
就在一年多前，我第一次走进 Uber 旧金山办事处。开始了为期 12 周的实习生活，我将开始了解技术写作的世界但我当时不知道会发生什么。
有些问题其实一直萦绕在我耳边，例如技术作家的工作究竟是做什么？我想长期在 Uber 工作吗？在整个实习期间，这些问题的答案变得越来越清晰。我在夏天实习期结束时找到了答案并且确信这就是我想要追求的道路，我最终选择并且非常高兴接受这份工作。
在大学毕业后选择工作时，我面临的问题从来不是我想做什么？而是我怎么能完成所有这些事情呢？我一直在寻找一份能够让我发挥创造力和分析能力的工作。我期望自己能从事很酷的技术创新，但我对编写代码并不感兴趣。我希望有一份工作可以每天都有意外惊喜并且能够持续学习。Amazingly, technical writing checked every box.
技术写作可能是一种被误解的职业，所以我将自己的经历提炼成了七个常见问题。希望未来的作家和技术专家能获益。
技术作家究竟做什么？
尽管进行了数小时的在线学习，但直到我的实习走向深入并处理了大量激动人心的项目，才终于理解技术作家的工作。
通常，技术作家记录由工程师构建的服务或产品。该文档将有助于新用户理解产品，传播有关服务如何工作的信息，并将技术术语翻译成易于理解的文章。但是，文档工作只是技术作家的诸多任务之一。除了记录，技术作家还可以创建培训材料，分析数据，访问用户，编写产品案例，并提出信息架构问题的解决方案。有些日子你必须像工程师一样思考，而其他人则像项目经理一样。这项工作充满活力，充满挑战，而且收获颇丰。
技术作家最大的挑战是什么？
作为 Uber 的技术作家，我同时与多个项目的多个团队合作，这一工作模式需要频繁的上下文切换和多任务处理 — 有时是一个挑战！为了确保我能够在最后期限之前保持最佳状态并为我合作的团队服务，我必须保持高效率和时间计划的有条不紊。
因为我与多个团队合作，所以我也有很大的机会发挥影响力。这是非常有益的，因为我编写的文档和创建的学习内容可以帮助我的同事更快地理解、处理和学习信息 — 这对于 Uber 工程效率和生产力来说是一个巨大的帮助。
关于技术写作最大的误解是什么？
由于技术写作不是一个超级知名的职业道路，因此存在许多误解。最让我印象深刻的说法是技术写作很无聊。
这是完全错误的（除非你讨厌阅读和写作，并且希望与酷炫技术无关）。
事实上，这项工作非常有趣。正如我之前提到的，需要同时研究这么多有趣的项目。如果我对一个人感到厌倦，可以换另一个人休息几个小时。这样我可以保持参与度，也就不会觉得工作无聊。
关于技术写作的另一个主要误解是必须具备技术背景。正如您将在下一节中读到的那样，这也是错误的！
是否需要工程学位/背景才能成为技术作家？
许多人认为需要工程学位/背景才能成为技术作家，这实际上是另一个很大的误解。
我再大学里课程包括计算机科学，音乐和艺术。虽然计算机科学课程有助于理解技术概念，但我的教育中最有用的方面实际上是学习如何学习和倾听。在学校学习的一些技术工具和概念有助于我作为技术作家的角色，但最重要的是，他们引导我快速学习并提出问题，这对于科技写作工作至关重要。
技术作家来自不同的背景，你决不需要工程学位或背景来开始这个领域（尽管它肯定没有害处！）。如果有很强的写作技巧和学习的愿望，技术写作可能非常适合你。
为什么喜欢在 Uber 担任技术作家？
无论您处于职业生涯的哪个阶段，或者拥有什么职位，都必须考虑所在公司是否与您的目标和价值观一致。
在 Uber 工作最好的部分是人。无论是作为实习生还是全职员工，当第一次加入团队时，我的团队成员都竭尽全力欢迎并指导我 — 对我的团队来说对其他人也是如此。我在 Uber 遇到的每个人都对他们的工作充满热情，热情和热情。办公室的能量具有传染性，强烈的社区意识和自豪感使我每天都期待上班。
我很喜欢 Uber 是一个可以通过向上和横向流动来建立自己职业生涯的地方。我的一位同事刚刚从技术作家角色转变为软件工程师角色，另一位同事转变为项目经理角色，都在 Uber 内部完成转变。我欣赏 Uber 对于岗位流动性的支持态度。
特别是从技术写作的角度来看，我认为优步是一家伟大的公司。我得到了各级管理层的支持，他们真正看到了技术写作的价值。感谢这种支持，我知道我的工作很重要。当我的工作项目遇到挑战时，这有助于让我保持积极性。
最后，成为 Uber 家族的一员让我很兴奋，因为我们所做的工作不仅影响了现在，也影响了未来。我很高兴能成为一家正在改变交通运输业的公司一员。
与其他组织相比，Uber 的技术写作有何不同？
因为我的行业经验有限，所以我征求了 Uber 技术作家的帮助，以此来讨论这个话题。
高级技术作家亚当·帕夫拉卡（Adam Pavlacka）：Uber 非常重视引导工程师撰写并真正鼓励良好文档的工作文化。虽然许多公司只聘请作家提供文档或从工程师的笔记中抄写原始副本，但 Uber 聘请的技术作家会以更加亲力亲为的方式学习他们正在撰写的主题。
给有志于成为技术作家的最大建议是什么？
如果您想成为技术作家，请立即开始写作！您不需要正式工作来练习技术写作技巧。查找有关您使用的产品或应用的现有文档，并了解如何改进它。与需要文档帮助的开源项目一起工作。查看有关激动人心技术概念的在线教程。这些小步骤将有助于建立您的投资组合并发展您的技能。
如果你认为自己不够“技术人员”或者不适合技术作家的模式，也不要放弃成为技术作家的想法。条条大路通罗马！如果您有志于成为技术作家，请遵循您内心的愿望走向成功。
