软件开发人员，为什么还没有开始技术写作？

出于多种原因，博客不仅对您而且对其他技术软件开发人员来说都是有用的。

技术写作帮助软件开发人员与软件工程中的其他软件开发人员分享他们的技术知识/经验。

技术写作是一门写作学科，涉及向需要它来执行特定任务或实现特定目标的人传达复杂的信息。正因为如此，技术写作通常被定义为“简化复杂的事情”。

它还可以增强您对所写主题的理解，并清楚地展示您的技术专业知识。

技术写作最独特的事情不仅是你能够创造极好的未来机会（科技领域的远程工作、自由写作合同或大型科技公司网站的客座机会等），而且它可以帮助你建立最终帮助您成为软件开发人员的在线形象。

有时，当我寻找特定主题的信息时，我确实会回去阅读我的博客文章。

如果你在软件工程职业生涯中做了一些有趣的事情，但你把它保留给自己，那么你就会错过一个巨大的机会。

开始写作，这是在互联网上推广您的想法的有效方式。

“写下您希望找到的博客...... https://t.co/PcXR0fL9QF

- Ankur💻🎧💪 (@TheAnkurTyagi) 2023 年 10 月 3 日

此外，如果您喜欢帮助他人学习，喜欢参与开源项目并向他人展示如何加入，或者通过写作以易于理解的方式解释复杂的想法而感到满足，那么技术写作非常适合你。

在本文中，我的目的是解释如何将编程和写作结合起来以提高我们的开发人员技能。是的，写作！我真诚地认为我们都拥有一定程度的写作能力。我在这里为您提供写作技巧、建议和示例，帮助您成为一名更熟练的开发人员和沟通者。

什么是技术写作

技术写作就是提供清晰详细的说明，帮助用户、开发人员或经理理解技术产品或技术技能或想法。

技术作家是创建这些教程和技术文档的人。

技术写作可以是：

• 如何进行用户指南或两种技术 SaaS之间的集成
• 在线支持文章
• 通常在进行研究或实验后提供有关特定主题的信息的技术报告。它们在科学和工程领域很常见。
• 技术提案，这些文件清晰且有说服力地概述了计划、想法或项目。它们用于寻求批准、资金或合作。
• 为程序员提供内部超材料，为开发人员提供API 文档。

本质上，技术作者以一种允许读者有效地将这些信息应用于特定目的的方式传达技术细节。

如果您开始进行技术写作，并尝试撰写有关软件开发/编程或您在技术中学到的知识，但尚未撰写第一篇博客，那么您会发现前两部分的最大价值在这篇博文中，我讨论了如何开始成为一名技术作家或博主，以及如何扩展您的博客。

您会发现博客的其余部分有助于填补您作为一名成功的软件开发人员所需的任何知识空白，并在工作场所蓬勃发展并推进您的职业生涯。

“如果你有一个梦想，你可以花一生的时间去学习、规划并为之做好准备。你应该做的就是开始。”

——德鲁·休斯顿

写作无处不在？

人们用来学习编码的前两个在线资源是技术文档和 Stack Overflow，博客也排在前三名。

使人们能够自学技术的三要素包括清晰的文档、提供解决方案的充满活力的社区以及频繁的帖子。

开发人员重视各种额外的资源，包括操作视频、书面教程、书籍和论坛——他们将最适合他们学习风格的资源和格式放在一起。

能够在团队内和在线清楚地表达您的想法是一项宝贵的技能，因为许多开发人员发现这具有挑战性。想想你每天写了多少不涉及代码的写作。这个技能是一种超能力。

您参与各种形式的写作，如 Slack 聊天、电子邮件、内部开发人员文档、RCA 草稿、自述文件、代码评论、Git 提交消息、拉取请求、代码审查评论、年度绩效反馈、会议记录等。

掌握写作对于软件开发人员来说至关重要。写作技巧不足可能会阻碍他们的职业发展超过一定程度。许多工程师在职业生涯后期逐渐意识到“软技能与代码一样重要”。

年轻人：如果你开始每天写作 30 分钟并每月在线发布 2-3 篇博客，你的软件工程职业将会显着改善，并且你将在未来获得更好的技术机会，但很少有开发人员能够真正做到这一点长期。 https://t.co/damIJ5gXys

- Ankur💻🎧💪 (@TheAnkurTyagi) 2023 年 10 月 4 日

为什么写作对于开发人员来说至关重要

JavaScript、TypeScript、PHP、Go、Java——有很多不同的编程语言，您甚至可能精通其中的许多语言。

当我们努力在技术职业中编写更高质量的代码时，用日常语言有效编写和交流的能力成为一项至关重要的技能，而这项技能在软件工程领域可能会被低估。

软件工程不仅仅是代码。这是关于人+代码的。

作为一名软件工程师，我如何成为一名更好的作家

工程师如何表达他们对代码的想法与代码本身一样重要。无论您对此事持何种立场，我们都可以一致承认我们的言论能够增强或阻碍代码的有效性。

写作可以帮助你增加运气面积。

L = D * T，其中L是运气，D是做，T是告诉。

——杰森·C·罗伯茨

技术写作的 6 大好处

它可以帮助您更深入地理解概念。

• 您需要研究您正在解释的概念，这会让您接触到不同的想法、应用程序和陷阱。

• 当你向别人解释这些概念时，这些概念会更好地留在你的大脑中。

• 通过为他人构建和呈现信息，您经常会发现自己知识中的差距。因此，它还可以帮助您在开发职业生涯中取得更快的进步。

• 技术作家是终身学习者，因为通过每个新技术博客的研究和写作，您将成为该主题的专家。

• 写作还可以促进对用户同理心的更深入理解。它促使您更多地关注读者或产品用户的观点和感受，而不是仅仅依赖于您的观点。

  
  

• 以下是一些额外的好处：

此外，您可以通过为各种组织做出贡献来作为技术作家获得收入。看看这些支付技术作家费用的很棒的公司。

大学时，我在宿舍里辅导别人学习

解释某件事，甚至假装解释，会迫使你连贯地组织你的知识，暴露你知识中的差距并强化你确实知道的部分。

最好的学习方式是教学，而写作对于每个开发人员来说都是一笔宝贵的财富。

人们和企业不仅会关注您，还会回报您。当您撰写技术博客文章时，您会收到即时反馈。您的技术写作还有助于传播信息，为更有趣的机会打开大门。

如果你发现自己喜欢技术写作，那么它也是一个利润丰厚的职业，而且这些天我在博客上写的几乎所有内容都是我试图更好地理解的概念。如果我不能用书面形式解释它，我就没有正确理解它。

技术写作的例子有哪些？

作为一名技术作家，您的角色包括将复杂的技术信息翻译成易于理解和用户友好的语言。技术写作包含多种形式，包括创建分步教程和综合指南。

主要目标是促进内部团队成员或最终用户对产品或服务的任何技术方面的理解。

考虑到这一点，以下技术写作示例应该能让您有一个清晰的理解。

1. SuperTokens 评论 – Auth0、Firebase Auth 和 AWS Cognito 的开源替代方案。

这是超级令牌审查的一个非常简单的示例，以及为什么“超级令牌”是良好的用户身份验证。

2. 如何使用 Medusa 创建 Next.js 电商商店

这是一个很好的示例，说明了如何在构建应用程序的同时构建教程。在此博客中，我分享了由 Medusa 构建电子商务商店的分步指南，Medusa 是 Shopify 的开源替代方案。

3. 如何使用 MindsDB 和 OpenAI 部署法学硕士

在本指南中，我分享了如何使用 MindDB 和 OpenAI 部署 LLM

4. 如何将数据库从 Supabase 迁移到 HarperDB

有关如何将数据库从 Supabase 迁移到 HarperDB 的完整教程

5-产品文档

产品文档包括有关有效使用其他开发工具以及与其他开发工具集成的说明。

编写产品文档需要良好的技术写作技能和组织知识。这些只是技术写作中的几个例子，技术写作需要高水平的研究、可视化技能以及与广泛受众建立联系的能力。

提示-“问问自己，‘标题是否引起了读者的兴趣？’如果确实如此，他们可能会深入研究介绍，然后决定，“值得在整篇文章上投入我的时间吗？”我在技术帖子中经常观察到的一个普遍错误是介绍过多，或者相反，介绍过少。

精心设计的段落可以有效地为技术博客文章奠定基础。

我如何开始成为一名技术作家

到目前为止，我关于“技术写作或博客”最常见的问题是如何开始。

在生活中，做某事并成为你想成为的人的最大障碍似乎就是开始。

最大的敌人是“自我怀疑”。 pic.twitter.com/fw1691QRSY

- Ankur💻🎧💪 (@TheAnkurTyagi) 2023 年 8 月 10 日

无论是开始新的锻炼方案、马拉松训练、创业、写书，或者更具体地说，在本例中写作，最困难的部分总是开始。

浪费无数时间争论你应该做什么是很容易的，而且很诱人。

“阅读”、“阅读”和“学习”比开始“写作”容易得多。

但是，秘密是，您一次只需迈出一步。

在你的软件工程职业生涯中建立至少一项复合资产

– 创建博客 – 开始时事通讯 – 开始录制 YT 视频 – 开始播客 – 开始建立网络

构建、发布和重复

未来的机会在互联网上等着你

抄送@TheAnkurTyagi

— Kap.ts (@Kaperskyguru) 2023 年 2 月 17 日

环顾四周；大多数软件工程开发人员并不是 24/7 都在编写代码；我们大多数人每天都会花大量时间做其他事情。

包括了：

• 在公司或客户的整个团队中演示新功能。
• 记录产品中的新功能或旧功能。
• 更新与 JIRA 票证相关的内容。
• 创建积压工作来支持该新功能。

当然，总有时间上厕所/吃午饭，也有时间刷推特😉

所以不要想太多——开始吧

“写作就像学习打篮球。”

——大卫·佩雷尔

要成为一名成功的作家并找到机会，您必须具备 3 项技能。

• 编码
• 写作
• 英语

是的，在开始写作之前，您必须首先了解英语，包括它的时态、拼写和基本语法。

您的读者不想阅读一篇充满语法错误和糟糕的用词选择的文章。

在科技行业，英语已成为全球软件开发人员、工程师和其他科技专业人员之间沟通的事实上的语言。它是用于文档、编程语言和开发工具的语言。

学会简单明了地交流想法

知道如何实现技术功能并不一定意味着您可以向其他人解释该过程。

成为一名好老师需要同理心和以适合目标受众的方式传达信息的技能

如果你不能向六岁的孩子解释某件事，你就无法理解它。

爱因斯坦，阿尔伯特

成为一名杰出作家并没有完美的策略。那么，您可能想知道我为什么要讨论这个话题。这是因为从一开始就解决这个问题至关重要。

“不要寻找策略；而是寻找策略。”寻找你在写作中独特的声音并建立你的风格。”

您应该知道的唯一写作技巧。

• 技术越少越好，我 90% 的时间都在使用 React。

• 如果您是第一次写作，请给自己更多时间来弄清楚。

• 允许自己写得不好。

• 停止准备并开始行动。

  
  

如何成为人工智能时代的杰出作家：

在撰写下一篇博客文章之前，请 ChatGPT 就该主题写一篇文章，并向您展示互联网上已有哪些通用内容，这样您就可以避免说出这些内容，并写出对受众来说重要且独特的内容。

- Ankur💻🎧💪 (@TheAnkurTyagi) 2023 年 2 月 16 日

要了解您的受众，请在开始写作之前询问这些问题。

• 谁是你的读者？
• 他们在 Google 上搜索什么或者他们面临什么问题？
• 他们目前正在阅读哪些博客？
• 他们将如何阅读？

如何提出博客文章的想法

• 写一篇文章可以让你不用花几个小时谷歌搜索和摸不着头脑。

• 每当你学习新东西时，写下你是如何学习的以及你学到了什么。

• 写一个关于你的领域、兴趣或职业的故事。

• 从您最喜欢的博主那里选择一篇您觉得有趣的博客文章，并从新的角度探索同一主题，或者从相似的角度处理不同的主题。

  
  

写下您希望在谷歌搜索时找到的博客文章。

- Ankur💻🎧💪 (@TheAnkurTyagi) 2023 年 3 月 20 日

注意 - 如果您在软件工程职业生涯中做了一些有趣的事情，但您将其保留给自己，那么您就错过了一个巨大的机会生成器。

当谈到有效地推广你的想法时，最好通过写作来浏览互联网。

撰写技术帖子和教程是一个最佳时机。为还没有时间学习该东西的专业人士写作，并将其与他们已经知道的东西联系起来。例如，向了解 jQuery 的人解释现代 JS 技术。

- 雷切尔·安德鲁 (@rachelandrew) 2019 年 2 月 20 日

结论

对于大多数熟练的开发人员来说，写作是一个容易实现的目标。

如果您认为可以通过阅读博客文章学到很多技术知识；这周尝试写一篇。

- Ankur💻🎧💪 (@TheAnkurTyagi) 2023 年 10 月 2 日

每个开发人员都应该写一篇关于他们在软件工程中学到的知识的博客文章，因为写作让他们发现，也许他们对某些东西的理解并不像他们想象的那么好。

教授和撰写任何内容是了解它的最佳方式，对于您开始新的生活方式来说，这是一个唾手可得的成果，因为您已经有了第一手经验，所以您所要做的就是出现，写一篇 12 篇博客文章评估今年的成果，并计划你的下一步行动！

“阅读是为了收集点，写作是为了将它们联系起来。”——大卫·佩雷尔

最重要的是，磨练你的写作技巧并在写作中付出一些额外的努力可以真正提高你作为开发人员的能力。您可能会发现这些技巧对于与其他开发人员协作、维护您的工作、在需要时创建内容、甚至起草项目提案等任务很有用。

技术写作资源

• 技术写作建议（CSS Tricks 的 Chris 撰写的一篇写得很好的博客文章）
• 技术写作资源（ Cynthia Peter的 GitHub 存储库）
• Google 的技术写作指南
• 技术写作基础知识
• 编写文档