为什么每个开发者都应该成为作家

我最近浏览了开发者社区的话题，发现了一篇很棒的文章，它为想要开始撰写技术文章的人提供了一些技巧。因此，我决定就此主题撰写一篇我自己的文章，并引用这篇精彩文章中的一些内容。

以下部分技巧和参考资料仅出于实用目的摘自原文，旨在避免读者在原文中查找内容。但所有观点均为我个人观点。

我为什么要写作？

每个人，无论是不是程序员，都应该写写自己在做什么、在学什么，否则就只写写自己的生活。

文章中提出的一个观点很有意思，也是我们平时不太会考虑的。每当我们在网上阅读技术内容时，我们都会把内容的创作者视为权威人士，或者至少是该领域的权威人士，这对你的职业生涯和个人发展都非常有益。

与领域专家合作总是有益的。当人们在网上阅读你的文章时，他们会把你视为专业人士，并更加信任你。

• 摘自参考文献

而这正是你作为开发者应该开始撰写技术内容的原因之一：巩固你作为开发专业人士的地位，不仅有助于你未来的职业发展，还会影响你处理问题的方式。经常写作的人能够获得在就业市场中至关重要的技能：

• 它能提高你的口头和书面表达能力：因此，它能改善你与客户和其他同事的沟通方式，此外，它还能帮助你以更清晰、更简洁的方式提出和表达论点。
• 它能让你拥有全新的思维方式：文章创作是一个非常复杂的过程，我们稍后会详细讨论。它需要你具备组织性和具体的结构，仅仅抛出想法是写不出东西的。思考写作本身就是一种以不同视角看待世界的绝佳方式。
• 让你做好应对反馈的准备：当我们在互联网上展现自我时，会面临各种各样的反馈，无论好坏，了解如何应对都至关重要。这能帮助我们培养批判性回应的能力，并以谦逊的态度接受赞美。

我们已经讨论了很多关于写作作为一种技能可以培养什么，但除此之外，我们为什么要开始写作呢？

巩固学习

你可能听过“只有教导他人的人才是真正学习的人”这句话，或者它的各种变体，对吧？

这是真的。教别人会迫使你寻找关联并巩固知识。一个非常简单的方法就是把它写下来。

写作会让你思考如何用最简单、最容易的方式让读者理解你想传达的内容，它有助于你以简单快捷的方式巩固你的经验和知识。

或者，如果你和我一样，你写文章的动机可能仅仅来自于与他人分享知识的愿望，以及想要观察和分析与你不同的观点和意见。

照亮你

作为一名专业人士，让别人了解你的工作内容和你的优势至关重要。那么，你希望别人了解你什么呢？如果你梦想加入一家公司，却不知如何实现，那么提升自身知名度不失为一个好办法。毕竟，所有公司都是由人组成的，他们需要知道你的存在。

除了职业优势之外，写作还能让你跻身于那些在他人眼中成为他们所谈论领域的权威人士之列，因为许多人会寻求他们的内容来完成学校作业，甚至创作个人项目。

直到今天，我仍然记得，2010年我开始学习编程的时候，经常会浏览伟大的José Carlos Macoratti的网站——当时我用的是.NET编程——直到今天，他仍然是我最重要的灵感来源之一，尽管我已经将近十年没碰过C#代码了。还记得艾萨克·牛顿那句名言吗？

我之所以看得更远，是因为我站在巨人的肩膀上。

——艾萨克·牛顿爵士

你可能就是其他巨头赖以开发其产品的巨头之一，你可能永远不会知道这一点，但其他人会知道——也许是你非常想去的那家公司的人力资源经理！

它捕捉你的想法

最后，但同样重要的是，写作能够积累知识，这可能决定一个项目的成败。你写作的目的并非为了成名，而是为了记录自己的知识，创建一个有用的信息库，以便在需要时可以检索。

我个人的一个例子——它不止一次帮了我大忙——就是我的笔记库。这是一个简单的地方，三年来，我把几乎所有课程的学习心得都记录了下来。里面有示例代码库、技巧提示、学习思路，甚至还有完整的讲义。

公开地——甚至是私下里——写下某些事情，可以让你记录下那一刻，并留下书面的心理记录，可以把它想象成你大脑在某个特定时间的快照。

为什么大多数开发者不写代码？

我们是开发者，不是记者，更不是专业作家。种种因素似乎都在阻碍开发者写作。写作面临诸多难题，其中一些比其他问题更为紧迫：

• 内向：开发者天生比较内向——这通常也是我们选择这个职业的原因，毕竟与人打交道比与机器打交道要容易得多——这在很大程度上影响了我们通过互联网向全世界表达自我的方式。但内向是可以克服的，玛丽安·桑塔纳的文章就是一个很好的例子。她之前从未写过文章，现在这篇文章却跻身DEV社区阅读量最高的7篇文章之列🤘
• 规划：开发人员通常焦虑感很强，但试图一次性写完所有内容是没有意义的，我们需要一个计划。
• 缺乏练习：很遗憾，除了“熟能生巧”之外，我们对此也无能为力……只有不断练习写作，才能提高写作水平。阅读也对增加写作词汇量和改进写作方式大有裨益。
• 害怕被批评：正如我之前提到的，当我们在互联网上公开自己的信息时，我们会受到各种各样的批评。因此，许多人因为害怕受到严厉的批评而选择不写作。在这种情况下，我们其实没什么好办法，只需充分了解自己所写的内容，并做好回答问题的准备——当然，不参与互动也是一种选择。

我希望当初开始写作时就能拥有的指南

下面，我将简要介绍一些我在多年撰写技术文章过程中总结出的技巧。这正是我三年前刚开始写作时梦寐以求的指南。

定义一个主题

你可以写任何内容。比如你使用某个工具的体验？或者你的学习过程？又或者你对音乐的学习如何影响了你的开发生涯？总之，一切由你决定！

没有人会期望你写一些你专业领域之外的东西，更不用说让你成为你正在学习的领域的权威（只要你明确表示你在学习），你可能会对此感到不自在，但另一方面，分享你做事的方式和你的日常习惯可以帮助其他人了解如何做得更好。

观点总是很重要的……

其他写作思路：

• 关于任何主题的个人经验
• 您最喜爱的科技领域的新闻
• 人生故事，你自己的，或他人的
• 你在旅途中获得的经验教训、失败教训、成功教训和感悟

研究，然后计划

技术写作中一个尤为关键的步骤是搜索。你可能不会是第一个撰写某个主题的人，但在开始写作之前，务必先做一些研究。此外，还要事先制定一个写作计划：

• 安排文章发布时间：正如我在关于个人规划的文章中所说，所有事情都需要计划，文章也不例外，请提前规划好发布日期。
• 了解你的主题：提前知道你想写什么。
• 规划文章内容：在任何地点写下文章大纲，包括主要标题和主题。

看看有没有其他主题相同的文章。撰写相同主题的文章是可以的——就像我在这里所做的一样——但请确保文章不构成抄袭，并且始终注明原文出处。以下是一些选项：

• 您在这方面的个人经验
• 不同的观点
• 关于该主题的补充说明（例如本文）
• 翻译成其他语言（始终注明原作者）

尽可能多地寻找关于同一主题的不同观点，你纳入的观点越多，你的文章就会越丰富。

给它起个名字

文章标题决定了读者的阅读兴趣，因此必须精心构思。标题必须清晰简洁，并能体现文章的主旨。我将在参考文献中引用文章中的一些内容：

• 第 58 期综述：Orleans 3.0、Snitch、你怎么了？ASP.NET Core 的未来五年
• 统领所有编程语言
• 遇到技术性扣款问题？

看看为什么这些例子不好：

1. 关键词太多，内容太杂，标题太长，而且似乎什么都说了。
2. 非常“深奥”，明显像是为了吸引点击而写的，但并没有提供多少理解材料内容的信息（这一点也适用于第3点）。
3. 以问题作为标题并不是一个好标题。它会引起读者的疑惑，并让他们期待得到答案。如果你的答案不能让读者满意，那么你就损害了你在特定读者心中的声誉。

现在来看一些很好的例子：

• 编程和音乐职业生涯：我从中学到了什么？
• 使用 PostgreSQL 开发 CRUD Node.js 应用程序
• 教程：基于 Kubernetes 的 MongoDB 和 Kafka Connect 数据管道

请看，安娜关于音乐的文章中包含一个问题，但这个问题不是问读者的，而是一个反问句，指的是她自己，解释了文章的主题。

结构

所有文章都必须遵循一定的逻辑推理，这是我们在学校学到的知识。所有文章都必须包含以下内容：

• 标题
• 介绍
• 开发（这里放置代码、图片和示例）
• 结论
• 参考

技术文章也不例外，唯一略有不同的是参考文献部分，该部分通常用于将文章链接到你的其他作品。

时间

Data Lab 的一篇文章指出，文章的理想时长为七到十分钟。这并非硬性规定，但确实有助于您把握文章的长度。我使用VSCode的一个扩展程序来显示这些信息。

但如果你要写的是更详细的文章或教程，那么这次花时间写也没什么问题，毕竟这是你自己的内容。你可以考虑把它分成多篇文章，形成一个系列，就像我写很多文章那样。

内容

人们期望看到你所说的内容能够经受住考验。避免使用过于复杂的词汇，也不要像写科学论文那样写作——除非你本来就是这个意思。

尽可能包含图片，使用gist和Carbon或CodePen来包含代码片段。

其他一些内容创作建议：

• 避免过于随意，但也避免过于正式。
• 测试 Grammarly（如果您用英语写作）或 Microsoft Editor 等应用程序，并信任文本分析扩展程序。
• 发布前务必校对您的文本。
• 看看有没有其他人可以读一下这段文字，以便进行修改。
• 首次在文章中使用缩写词时，请将其展开，例如：“使用AKS（Azure Kubernetes 服务）……”
• 撰写文章时，除非是评论文章，否则最好使用第一人称复数，因为“我们”能与读者建立一种集体感。
• 不要写长段落
• 每当你提供数据（数字等）时，请注明数据来源的日期和出处。

关键词

关键词很重要，因为搜索引擎会通过关键词索引你的文本。要查找可以使用的标签，请参阅我引用的文章中的一些直接示例：

• moz.com
• app.neilpatel.com
• trends.google.com
• keywordtool.io
• wordtracker.com/scout

至少使用五个标签来指示你正在写的内容，标签级别应从最通用到最具体递减，例如：open-source, back-end, javascript, node.js, cli。

分享与宣传

不要害怕尽可能多地宣传你的作品，使用Buffer、Hootsuite等工具管理你最常用的社交网络，并安排你的帖子发布时间。利用社交网络上与你所写内容相关的群组，你的目标受众就在那里。

提示：持续发布关于您文章的内容，但避免重复文本，许多社交网络算法会将同一帐户中的重复帖子识别为垃圾邮件。

总结

我尽力将近年来通过撰写技术文章所学到的知识分享给大家。我希望这些建议也能激励您创作更多文章并分享您的作品。

请务必关注我的博客，获取更多内容，并订阅电子报，每周接收最新资讯！——目前博客内容仅提供葡萄牙语版本。

如果你想开始写作，但不知道你的文章写得好不好，想让我再看看；或者你已经写好了文章想分享，请通过我的社交网络把你的内容发给我，我很乐意看看！

您可以在我的网站上找到它们：https://lsantos.dev

再见！