原文： How to Become a Technical Writer
技术写作帮助你与他人分享你的技术知识和经验。技术写作在展示你的技术能力和才能的同时，也可以强化你对所写主题的了解。
在这篇文章中，我将阐述想成为一名技术文档工程师，你需要知道什么。我们将了解什么是技术写作、技术文档工程师需要的技能、如何成为一名技术文档工程师，以及了解一些能帮助你真正精通技术写作的技巧。
什么是技术写作？
我们可以用很多不同的方式来定义技术写作。但是 Grammar 上的定义是最有用的，它准确地解释了技术写作的含义：
“技术写作是作者就一个特定的主题写作，这个主题要求具有指导性、指示性或说明性作用。”
简而言之，技术写作涉及对某一特定主题直截了当、易于理解的说明和指示。
技术文档工程师需要具备什么技能
在那些曾经想要成为作家的人中，存在着一种常见的假设，即他们无法写出好文章是因为他们天生就没有写作天赋或写作技能。这就衍生了一个问题：作家是天生的还是靠后天培养的？
我很好奇其他人对这个普遍的假想是什么看法，于是我在推特上发了一条信息。
阅读每个人的观点都很有意思。大部分人说他们相信作家是天生的，另一部分人持反对意见，认为作家是后天培养的。有趣的是，还有一部分人认为作家既是天生的又离不开后天培养。很疯狂对吧？
我相信你很好奇我对此的看法，那么我将在下文告诉你。😉
我相信任何人，无论是否与生俱来拥有某种能力，都可以通过学习成为一名优秀的作家。我知道我不是生来就有写作天赋，所以我决定更加用心地学习如何写作。
说实话，你今天看到的大多数技术文档工程师很有可能都必须通过培养或学习特定的技能而变得擅长写作。
现在进入正题😃，要成为一名成功的技术文档工程师，你应该培养以下五项必备技能：
知道如何写作
我知道你可能会觉得困惑，为什么说写作是成为一名技术文档工程师所需的技能之一。你可能认为技术写作和写作是一样的，但是其实它们并不一样。
一般情况，写作就是使用符号（字母表的字母、标点符号和空格）以可读的形式传达思想和想法的过程。而另一方面，技术写作就是更具体地从逻辑和技术上来分享或表达你的想法、观点、指示和建议的过程。
每个技术文档工程师的首要技能是能够用他们首选的语言进行写作交流。例如，如果你打算用英语来写技术文章，你需要知道英语是如何构词和交流的。
想要更好地写作吗？试试以下步骤：
- 学习你首选语言的语法和语言规则，以便交流。
- 明白插图在写作中的作用。
- 多阅读！相信我，阅读将帮助你扩大你的词汇量。
- 最重要的是，使用你首选的沟通语言进行写作。
了解你的读者
识别和了解特定读者，并为他们定制输出你的内容将使你的文章或文档脱颖而出。这就是为什么你需要了解你的读者。
你了解你的读者后，就能写出为他们量身定做的文章，满足他们的需求，从而自动有效地传递信息。
那么，你如何才能了解你的目标读者呢？
问问自己关于读者的问题
你需要问自己这样的问题：“谁是我的读者？他们为什么要读这篇文章？他们希望从文章中得到什么？”
例如，在我开始写这篇文章之前，我问了自己这些问题，并得出了以下答案：
- 谁是我的读者？是那些想要成为技术文档工程师的人。
- 他们为什么要读这篇文章？为了学习成为一名技术文档工程师所需的必要技能。
- 他们期待获得什么？可以帮助他们开始行动并最终成为技术文档工程师的一切东西，比如技能、技巧、步骤、建议等等。
当我想清楚这些问题的答案，我就能够定位我的目标读者，就是那些初学者。这有助于我打磨这篇文章并帮到你。
使用正确的术语
如果你的目标读者是初学者，你应该使用容易理解的术语。你也可以添加具体的例子来帮助读者理解。
给你的文章或文档取一个有用的标题或名称
文章名称应具有描述性并对读者有帮助。
例如，当内容是关于 React 中的元素渲染时，就不要将文章命名为《深入了解 React》。这样会让那些期望在阅读完你的文章后能了解 React 所有知识的读者失望。
相反，想一个具体的标题，准确描述你文章中所写的内容，如《如何在 React 中渲染元素》。
培养你的技术能力
作为技术文档工程师，你的目标是帮助读者以最直接的方式理解高度复杂的过程或概念。
要做到这一点，你需要熟悉你所写的主题。这意味着如果你想写一篇关于 React.js 的技术文章或文档，你应该做到自己也会使用 React。
我将以阿尔伯特·爱因斯坦（Albert Einstein）的这句流行名言来结束本节：
如果你不能向一个六岁的孩子解释它，你自己也不会理解它。
这句话也呼应了在向别人解释你的主题之前，彻底理解主题技术细节的必要性。
能够做好研究工作
是的！技术文档工程师并非无所不知。所以，即使你可能熟悉一项技术，有时你也必须研究一种语言或框架，以便在你开始写作之前更好地理解所写主题。
这将确保你的文本是准确的并能最有效地传达必要的数据。你肯定不希望分享虚假或令人困惑的信息。
你应该如何进行研究？
研究的方式包括在你喜欢的搜索引擎上提问、请教对该主题了解的人（如果你认识的话）或者阅读书籍。
如果你决定使用搜索引擎的方式，就针对你想要发现的内容提问。例如，如果你想了解如何在 React 中使用 GSAP ScrollTrigger 插件，你的问题应该遵循这样的格式：“我如何在 React 中使用 GSAP ScrollTrigger 插件”。
如果你决定询问对该主题了解的人，记得要有礼貌，直奔主题。你可以遵循以下询问方式，而不是说完 “你好” 就等着对方回复后才提问。
“嗨，Rita，我叫 Edidiong。我知道你对使用 GSAP ScrollTrigger 插件非常了解。这些年来，我看过一些你的 CodePen 演示，它们看起来都非常棒。我很想知道如何操作 GSAP tween 滚动触发动画？如果你因为工作繁忙而不能回复，我完全理解。但如果你能回复，我将很感激。”
你可能觉得这是一条相当长的信息，但它包含了最重要的事情：你的名字、你对对方工作的钦佩、你的需求，以及你明白你无权占用对方的时间。
在研究阶段，你还可以选择阅读书籍。为此，你可以去图书馆或在线查找书籍阅读。
形成独特的写作风格
你有没有想过为什么人们会给一篇文章留这样的评论，“哇，看了你的文章，我终于理解了这个概念”，或是“我读了其他人写的文章都没理解这个概念，但读了你写的就豁然开朗了，谢谢你！”
如果你问我，我会说这是因为作者用了他自己独特的写作风格来写作。
这是什么意思？ 意思是每个人都是独一无二的。
所以，如果两个开发人员写同一个主题的文章，一些读者会更容易理解第一个开发人员写的文章，而另一些读者会更容易理解第二个开发人员写的文章。为什么会这样呢？ 因为两位开发人员都有自己独特的写作风格，不同的写作风格会适用于不同的读者。
那么，你如何才能形成自己独特的写作风格呢？
忠于自己，像一个作家那样，让你的思想自由流动，而不是复制其他作家的内容。是的，从他人那里获得灵感，但不要忘记你是谁！
事实上，人们的学习方式各不相同。有可能你写的内容刚好就是某个开发人员在真正理解一个概念前希望能阅读到的内容。
现在我们已经讨论了成为一名优秀技术文档工程师所需要的基本技能。我要说的是，这些技能可以慢慢习得，不用等到你全部都会了才开始写作—试着开始写作吧。
如何成为一名技术文档工程师
现在，我们来谈谈如何成为一名技术文档工程师。💃🏽
取得进展的秘诀就是开始。——马克·吐温（Mark Twain）
是的，我不得不从马克·吐温的这句名言开始说起，因为这是我们在接受新挑战时都需要记住的事情。下决心成为一名技术文档工程师是件好事，但是开始采取行动更重要。
我们来谈谈想成为一名技术文档工程师你需要做的四件重要事情。
参加技术写作课程
技术写作是一项紧缺的技能，雇主希望为团队招募到最优秀的技术文档工程师。参加技术写作课程的重要性被严重低估，但它其实是有必要的，因为你会了解到很多技巧，这些技巧可以帮助你成为一个更优秀的技术文档工程师。
参加完谷歌的技术写作课程后，我的技术写作技能明显提高了，所以我强烈建议你也参加这个课程或者其它类似写作课程。
阅读书籍和技术文章
读完一千本书，你将文思泉涌。——邝丽莎（Lisa See）
阅读是必不可少的，因为它将帮助你丰富你的词汇量、紧跟当前的趋势、了解写作界正在发生的事情、同时保持写作动力不竭。
为此，我强烈建议你去 freeCodeCamp、Hashnode、The Writing Cooperative 等网站阅读技术相关的文章。
开始写作
在写作中学习写作，在阅读和思考作家是如何塑造人物和编撰故事中学习写作。如果你不能成为一个读者，那就别想成为一个作家。——琼·M·奥尔（Jean M. Auel）
即使你参加了所有的技术写作课程，阅读了所有你能找到的技术文章，这也不会使你成为一个技术文档工程师。你需要实际写作才能成为一名技术文档工程师。
你可能想知道如何才能真正开始写作。好吧，我来告诉你。
首先，你需要想好一个你想写的主题。然后你应该做必要的研究，写出文章初稿，并校对文章（至少两遍）。准备就绪后，你就可以在你的博客上发布文章了。
你不需要从头开始建立你的博客，因为这会占用大量时间且分散你的注意力，使你无法专注于写作这件正事。就我而言，我用 Hashnode 创建了我的博客，因为 Hashnode 速度超快，它有一个强大的社区，并且允许你将博客映射到你自己的域名。
在你对写作得心应手后，可以申请成为 freeCodeCamp 的专栏作者。如果你通过审核，就可以在 freeCodeCamp 的平台上发布文章，以此接触到更多的读者。
坚持写作
坚持写作在帮助你成为一个更好的作者方面起着巨大的作用。它可以释放你的生产力，转变你的观点，建立你的信心。
你一开始写不出好文章。一开始你写的都是废话但你还认为自己写得很好，然后你会逐渐写得越来越好的。这就是为什么我说最有价值的特质之一是坚持不懈。——奥克塔维娅·E·巴特勒（Octavia E. Butler）
就像其它技能一样，当你坚持写作时，你的写作能力就会变得越来越好。争取每个月至少写一篇文章，如果你坚持不懈，终会惊喜发现自己的写作技巧有了提高。
作为一名技术文档工程师，如果你想要锻炼你坚持不懈的精神，可以试试这个#1周2篇文章挑战。
什么是 1 周 2 篇文章挑战？
这项挑战的目标是鼓励技术文档工程师确定自己的写作目标，了解写作标准，最重要的是坚持写作。
参与者需要在自己的博客上每周至少发表 2 篇文章，共持续 4 周。如果能做到这一点，你将能在短短一个月内在你的博客上创建并发表 8 篇文章。很有趣，对吧？😉
我看到很多人都在谈论参加这个挑战的好处。我相信它将帮助你开始坚持写作。
为开源项目做贡献
开源项目的文档可以说和软件本身一样重要。因此，如果你是一个技术文档工程师，你就可以在文档方面为项目做出重要贡献，因为人们无法使用他们不了解的东西。
是的，你可能正在为一个项目或开源组织免费工作。但是，开源贡献可以帮助你提高你的写作技巧、扩大你的人际圈子，并帮助你获得开源组织维护者的推荐和介绍。
开源贡献还可以帮助你增加入选谷歌文档之季（Google Season of Docs）项目的机会。
什么是谷歌文档之季？为什么它很重要？
文档之季是由谷歌组织一个年度项目。其目标是连接技术文档工程师和开源组织，促进开源领域中的文档协作和提升。
这项活动非常重要，因为通过开源项目的文档，用户不仅可以理解该项目，还可以为项目做贡献。
在项目期间，入选的技术文档工程师将花费 3-5 个月的时间来构建一套新的文档、改进现有文档的结构、开发一个急需的教程或改进一个开源组织的贡献流程和指南。
这个项目的有趣之处在于，作为技术文档工程师参与开源项目贡献，你可以获得 3000 至 15000 美元的报酬 。你也会有更大的机会加入谷歌的技术写作团队，还有可能在项目结束后被开源组织留用，继续从事技术写作工作。
帮助你开始写作的 6 个技术写作技巧
完成初稿后，注意以下事项：
- 写作时采用一种风格指南 。它可以帮助你有章可循，且遵循最佳写作原则。
- 段落简短，每个段落仅表达一个观点。不要一个段落包含所有观点。
- 写出简短、清晰、准确的句子，因为大繁至简。
- 写完初稿后，假装自己是读者，大声朗读你写的内容。这将帮助你发现那些可以重新措辞的地方。
- 只在你精力集中的时候才编辑初稿。
- 通过咨询主题专家寻求反馈，因为技术文档工程师并不会知道每个主题的所有技术细节。
总结
技术写作仍然是专业工作场所中一项令人羡慕的技能。预计从 2014 年到 2024 年，技术写作需求将至少增长 10%。
写作像许多其它手艺一样，需要多年的实践来打磨。写作最好的地方在于你可以看到自己的进步。如果你努力练习，随着时间的推移，你就能看到你的写作能力比之前有很大的进步。
另外，技术文档工程师有一个很大的好处，那就是成为终身学习者。因为他们需要精通自己所写的任何领域或话题，以便向读者清楚地传达信息。我强烈鼓励你不仅要开始这段旅程，而且要坚持写作。
就写到这儿吧，朋友们！我希望这篇文章对你们有帮助。如果有帮助，可以在推特上关注我，获取更多此类内容。