成为一名技术作家

我的众多榜样之一曾经说过，她开始从事技术写作的原因是为了记录她在软件开发不断发展的历程中的新学习和新发现，以帮助她度过“再次遇到同样的问题/错误时迷失方向”的时光。

除了其他方法之外，一种深入教授、解释或分解逻辑的方法是通过写作，因为它可以让您在方便的时候探索所有的创造性思维，而不必担心怯场。

技术写作涵盖了所有这些以及更多内容，它涉及将复杂的技术流程或意识形态记录成更简单易懂的格式。它最初是从技术产品或服务的用户手册或说明书开始，后来发展到撰写技术或专业主题的文章，例如计算机应用程序和工具、软件开发语言和框架、医疗程序、环境法规等。

技能：

技术写作技能对某些人来说是天生的，而对其他人来说则是后天习得的，但总的来说，成为一名优秀的技术作家所需的一些重要技能包括：

1. 强大的写作和沟通技巧：必须具备用简单易懂的语言向读者传达复杂含义和术语的能力，因为它们可以激发读者阅读文章的热情，即了解他们一直以来都不明白的内容。
2. 与该领域相关的技术经验/技能：传达信息意味着理解并精通该信息，因此，您需要具备相关领域的知识和经验。我们假设您目前在该领域工作或具备相关知识，因此对您了解相关领域。许多技术作家在其领域担任技术职位，例如软件开发人员/工程师、信息安全分析师等。在您熟悉的领域写作，对创作出一篇优秀的文章大有裨益。
3. 兴趣：对技术有（巨大的）兴趣会让您在涉足技术写作时占据优势，因为它会激励您不断寻找新的技术来学习和写作。
4. 研究技巧：写作涉及（大量）收集和比较来自不同来源的数据和发现，结合您对该主题的个人知识，转化为有价值的书面信息。

流程：

撰写技术文章与撰写普通论文有很大不同，可能需要相当长的时间，因为大多数情况下，为了传达你的目标，你必须重新创建从简单到复杂的实际技术步骤。因此，在写作之前和写作过程中，务必采取以下精确步骤，以免文章出现严重缺陷：

1. 了解你的读者：读者始终是技术作家最关心的问题。了解你的目标读者群体，对于简化后续工作大有裨益。如果文章是为初学者撰写的，使用不熟悉的技术术语或高级术语，无法有效地传达信息。你的读者决定了所使用的文本以及信息的传达方式。为了更好地了解你的读者，在开始撰写文章之前，你应该考虑以下问题：

• 他们是谁？
• 他们需要（从你的文章中学习）什么？
• 他们会在哪里阅读您的文章？
• 他们为什么要读书？
• 他们会如何阅读？

这些问题对于帮助您了解您的受众大有帮助。

1. 规划你的文章：撰写技术文章似乎是一项复杂而艰巨的任务，而且有点令人困惑从哪里开始，但如果你的受众明确，创建地图或指南（开始<—>结束）就会容易得多。概述你的读者应该从阅读中获得的必要信息，并尽可能将它们转化为要点/指南，有些作者喜欢概述所有这些，即在文章开头创建一个概述，让读者了解接下来会发生什么。在你的文章中有一个有力的引言也有助于你了解文章的下一步要走的路。创建地图或指南有助于突出显示你可能没有想到甚至不知道的其他领域，并有助于让你更加熟悉和准备。

2. 反馈迭代：没有哪位作家拥有丰富的知识，正如科技专业人士鼓励评论和反馈一样，技术写作也是如此。在以读者的视角阅读自己的文章的同时，从同事、专业人士、领域专家等处获取技术评论和反馈，有助于在发表文章之前发现可能被忽略的语法和技术错误。

3. 内容创意：既然您已经了解了读者，并有了文章的蓝图或指南，那么在文章正文中清晰地传达信息的同时，保持写作风格，注入创意，将对吸引读者阅读到最后大有裨益。以下是一些示例：

• 词语选择：选择合适的词语并在必要时添加更多细节，有助于使您的文章更易于理解。

示例：打开命令行并在“documents”目录内执行 XYZ 操作

改进：打开命令行，通过输入“ cd documents”并执行 XYZ 操作进入“documents”目录。

• 经常使用主动语态：文本中使用主动语态比被动语态更容易阅读和理解。

示例： Node.js npm 软件包注册表中包含超过350,000 个软件包

改进： Node.js npm 包注册表 包含 超过 350,000 个包。

• 句子结构：将重要信息放在第一句话中大有帮助。

例如：在执行数据库更新之前，始终建议备份数据。如果不遵守此规定，则很有可能造成永久性数据丢失。

改进：建议在进行数据库更新之前备份数据，以避免永久性数据丢失。

• 避免使用技术俚语/缩写/行话：在撰写文章并大量使用信息时，我们很容易不经意地使用自己、朋友或同事熟悉的缩写/俚语/行话。撰写文章时，如果打算使用不熟悉的术语，最好先完整地陈述它们，然后定义它们，再使用缩写来引用，而不是直接跳到正文，让读者一头雾水。

示例： MVC模式 在各种框架中被广泛接受。

改进 ： 模型-视图-控制器 （MVC） 模式在各种框架中被广泛接受。

• 启用基于任务的方法：大多数技术文章都是以教程或DIY的形式提供给读者，因此以步骤的形式撰写文章也是使其更全面的好方法。确保遵循正确的步骤顺序，使你的写作流畅自然。

优点：

成为一名技术作家有很多好处，其中包括：

1. 持续学习，意味着你要不断尝试跟上新技术，提升阅读和写作能力，深入探索新领域，并持续获得反馈。这是一个不断提升的成长过程。
2. 这是一项备受推崇且收益颇丰的技能，因为任何真正擅长用更简单的语言向用户传达技术复杂性的人，对于组织而言都被视为“宝贵人才”，而组织也总是愿意为此付出高昂的代价。一些申请付费技术写作工作的热门网站包括Pusher、Scotch.io、logrocket等。
3. 对于技术人员来说，这是一种职业提升和额外的技能，因为他们能够快速掌握、分解并向用户传达技术的用途和重要性。

从技术文章开始，注册成为 Findworka 出版物的客座作家，在此注册：