[译]如何撰写精彩的技术博客文章

3,402 阅读10分钟

--- 从创意到精致结果的五个步骤

原文链接:medium.freecodecamp.org/how-to-writ…

我已经在开源社区工作了近 5 年,建立和推广包括 Meteor 和 Apollo 在内的开发者工具。在那个时候,我发现博客是传播思想的最有效方式之一。

写博文不像视频或会谈需要花费很长时间来准备,是个受众广且很容易完成的。我个人也从写作中获得了很多好处:它帮助我组织了自己的想法,向人们传播了我喜欢的技术,还让人们知道了我。

2014 年我发布了第一篇博文,到现在我已经在 Medium 上写了 68 篇文章了,其中一些文章有超过 50k 的浏览次数和 1000 个粉丝。我还为我的朋友和同事编辑过很多帖子。经过那段时间的锻炼,我已经有了一个把概念实现到发布成文的策略。

在本文中,我们将介绍撰写帖子的过程的五个主要步骤:

  • 全力找一个好主题

  • 明确目标和受众

  • 有一个好的开头结尾并且内容翔实

  • 获得反馈并进行迭代

  • 添加最后润色:包装,发布和宣传

让我们进入第一步吧!

1.全力找一个好主题

你需要先有一些想法才能开始写作。 那些想要开始写博客的人跟我说,没有想法通常是他们的主要阻碍问题。

最简单的策略是写你所知道的。 如果你花了很多时间学习某些东西,并且你认为你可以在几分钟内解释它,那么你将为读者提供很多价值。

另一个想法是写一个某个区域没有的内容。 例如,目前关于如何申请技术会议的帖子不多,因此有关这方面的内容可填补社区空白。

以下是可以使用的一些特定类型的帖子。 示例来自 Apollo 博客上与 GraphQL 相关的帖子:

1.实现特定目标的分步指南:“使用 FlatList 在 React Native 中构建一个出色的可滚动列表”或“使用 Apollo 和 Recompose 简化您的 React 组件”。 这些对于那些想要快速做一个 demo 的读者来说非常棒。

2.对特定主题的深入调查:“使用 GraphQL 中的可空性”或“GraphQL 查询的剖析”。 如果你的目标受众是对此感兴趣并且想要用一杯咖啡的时间来了解更多知识的话,这些内容会非常有用。

3.围绕一个常用主题较为有用的清单:“调用 GraphQL API 的 4 种简单方法”或“静态 GraphQL 查询的 5 种好处”。 这是一个有趣,轻量级的阅读,因为你不必阅读整体,是很容易利用碎片时间来完成的。

还有一些共同关注的问题,现在来打消这些疑虑:

1.关于这个话题已经被讨论过了。 不要担心。 即使这个想法以前被写过,你也可以用自己的视角,来阐述在你这种特定环境下的不同做法。

2.我的想法不够有趣。 我的很多朋友和同事都不写,因为他们担心他们的结论可能很无聊或显而易见。 这很正常啊! 如果你是某一方面的专家,那么理所当然你所写的结论对你来说会很无聊。关键是你的观众还不知道那些东西呢。

即使说了这么多,在最后也很难预测什么样的主题能成为一个精彩(火)的文章,哪样的不会,并且往往是坚持写或换个文章,而不是一个精彩的主题。 我的主要建议是尝试写几个不同的东西,看看哪些有用。

The lightbulb - a universal symbol for ideas.
灯泡 - 通常用来代表想法

2.明确目标和受众

既然你已了解自己的主题,那么需要为自己的帖子提供受众群体和目标。 谁会阅读它,他们将从中获得什么?

你的目标需要具体,以便你可以将所有精力集中在一个主要想法上。 对于这篇文章,目标不能只是“写博客”。 我需要一个更具体的目标:

  • 受众:想要开始撰写博客的人,特别是有关技术主题的人,但还没有做到。
  • 目标:为人们提供一套具体的步骤和指示,以便他们可以开始。

一旦有了这些,通过删除任何没有用的东西来保证你的文章主旨,避免添加额外的细节,因为他们需要有关联。 我发现相对简洁的帖子,阅读时间在 5-10 分钟时是成功概率最大的。

了解观众的知识背景能够根据他们现有的知识提炼文章,有助于确定如何发布和宣传文章的内容。 例如,我希望在 freeCodeCamp 上发布这个,因为目标受众中的很多人可能已经阅读过该出版物。

3.有一个好的开头结尾并且内容翔实

当文章结构走向奇怪时,会让人迷惑。 剧情曲折在虚构的短篇小说中可能是一个很大的好处。但如果能让读者获得想要的知识,那么这会是一篇更容易被阅读完的技术文章。 良好的文章结构,可以让读者顺利完成阅读。

介绍

文章的第一段或第二段一般既不能吸引读者的注意也不会让他们失去兴趣。开篇可以用一小段话和一副大图来帮助读者理解文章的主旨。然后,告诉读者他们阅读此文会知道什么。提前揭秘可能很诱人,但要注意:如果你没有好的提示,读者就不会围绕这个点去阅读。

中间

现在已经告诉读者会阅读什么,请满足他们的期待!你可以根据自己的需要随意添加详细信息,并在途中留下标志性文章以引导他们。多多使用标题,编号列表等来帮助读者了解他们阅读到文章的哪个部分,使他们能够跳读到他们最感兴趣的部分。

结论

不要在文章末尾一下子就结束。如果你的读者已经读完了所有的内容,他们仍然会关注最后还有什么。给他们一个所学东西的快速总结,一篇文章的最后也可能只是告诉他们如果感兴趣就快行动起来吧。

关于结构部分,我所建议的也许不是最有创意的,应该还有其他方法可以做到更好。 但简单的结构是与读者沟通的最直接方式。

Like road signage, your post’s structure guides people along.
就像路标一样 文章的结构样应该能指引读者

4.获得反馈并进行迭代

在你阅读之前,你不会知道人们会从你的写作中得到什么。这才是你所设想的主题,目标,文章细节和结构真正受到考验的地方。如果想获得好结果,则不能跳过此步骤。

当你想要获得反馈意见时,你可能觉得自己有点强势,或者你可能会担心这会产生负面影响,但是人们比你期望的更愿意提供帮助。在将文章发布到外面之前,最好先了解一下如何发布文章效果会更好。当我把这些都考虑进去时,我得到了一些非常有价值的反馈,使得文章内容更好,更有针对性。

你应该向你的读者问些什么呢?我的主要建议是尽可能保持开放性。尽量不要事先解释你的意图。按原样移交草案,并询问您的审稿人他们从中得到了什么或应该更改什么。当互联网上有人遇到您的文章时,他们是没有任何额外的(和读者认识啊这种的)背景的独立个体。

从反馈中验证的主要内容是:此帖子是否会实现您在第 2 步中确定的目标?保持迭代,直到你确定能明确目标和受众。

5.添加最后润色:包装,发布和宣传

既然你已经有了这个想法,目标,结构和一些反馈,那么现在是时候对所有东西进行润色并发布它了。

包装

想出一个好的标题和副标题,并确保你的文章至少有一张图。这是人们在 Twitter 或 Facebook 上分享文章时会看到的内容,也是让人们对阅读此文感兴趣的机会。

文章看起来和感觉起来都要很专业,这十分重要,这样才能够让内容真正有意义。最低目标应该是在文章中没有拼写错误,语法错误或奇怪的格式。如果您有一位非常善于发现小细节的朋友,请让他们在发布前仔细阅读。

在 freeCodeCamp 上发布文章也有一些关于编写样式和格式的好建议。既然你已经在你的文章中投入了太多的精力,那么额外增加一点努力来真正地完善它使之受众更广泛是非常值得的。

最后,请备注上引用的作品或帮助审核和修改帖子的人来表达谢意。

发布

终于到了这一步!选择你计划发布文章的网站,以便最有可能覆盖你的受众群体。Medium 通常是技术文章的汇集地,让人们很容易看到你的文章。

关于奖励,尝试将你的文章发布到相关的技术网站中,以便于他们帮助分享你的文章 - 由此考虑,我选择了 freeCodeCamp,因为我认为这篇文章与他们的读者有关。如果你也想这样做,请按以下方式提交你的文章。你感兴趣的领域的技术网站也可能正在寻找文章,所以不要害怕联系!

宣传

虽然你已经发布了文章,但是还没完事!如果你希望人们看到你撰写的内容并从中获取价值,请务必在读者可能会浏览的地方分享。这可能包括 Facebook 群组,Reddit,黑客新闻,LinkedIn 或任何其他平台。此外,请务必在你自己的社交媒体帐户(如 Twitter)上分享你的创作。你的朋友会很高兴阅读,分享和赞成你写的东西!

现在,你已经完成了。去喝咖啡或散步 - 从开始到结束一篇博文都是不小的壮举。阅读社区的任何反馈和回复,以便你可以不断改进。当你有另一个想法时,就再去写一篇吧!

Beautiful presentation can enhance an already delicious donut.
精美的图片能够锦上添花

练习没有替代品

在写作时,我们只是介绍了五个最重要的事情,从提出想法到发布。 现在你已经阅读过了,你尝试应用这个建议,看看哪些对你有用。

我会留下最后一点建议。 我在过去 3 年中从博客中学到的主要内容是,我绝对无法预测哪些文章会无人问津,哪些文章最终会成为一个完整的系列。 有时候,我会花费好几天的时间来打磨一篇文章的每个细节,不允许一点错误。 也有时候,只是在深夜花了几个小时写的“GraphQL vs. REST”,成为了我有史以来最热门的文章。

因此,即使你的第一篇,第二篇或第三篇文章没有成功,也要继续尝试新的东西,把你的想法写出来,并随着时间的推移而改进。 世界想要听到你要说的话。 去告诉他们!

非常感谢 Anvisha Pai,Angela Zhang,Katie Siegel 和 freeCodeCamp 的编辑帮助审阅这篇文章。