对于想要撰写第一篇博客文章的工程师,我给出了 7 条建议

我的职业生涯以 IT 项目经理的身份开始,但在进入新闻业之前,我的好奇心引导我走上了令人兴奋的编码之路(尤其是前端和 iOS)。

过去 6 年,我很荣幸地为法国科技公司众多开发人员和工程师的博客写作计划提供支持。从润色帖子到协作写作会议,甚至根据他们的想法从头开始创作文章,我都参与其中。

现在,让我们开始吧!以下是我喜欢与我合作的开发人员和工程师分享的 7 条重要建议。


分享是一种心态

随时都有可能找到博客文章主题的灵感,因此明智的做法是随时记录这些想法。无论您是在午餐、会议还是在浴室里集思广益,都要及时写下这些想法。就我个人而言,我依赖 iPhone 上的 Notes 应用程序,但使用最适合您的工具。关键是可访问性,确保您不会忘记那些创意火花。然后,当需要写作时,您将拥有一份现成的想法清单可供选择。

一旦你的帖子写好并发布,你的工作才刚刚开始。特别是如果你在开发者世界还不是家喻户晓的人物,分享你的帖子至关重要。无论是在社交媒体上、通过时事通讯还是在内容管理平台上,让你的作品广为传播都很重要。如果你选择社交媒体,那么在链接中添加个人风格可以大大提高参与度。

但不要只停留在分享上——通过响应征文通知 (CFP) 并就同一主题进行演讲,进一步利用您的研究和写作成果。将您的文章改编成演示文稿可能需要一些额外的努力,但这远没有从头开始那么令人生畏。请记住,这是双向的——您的演讲可以激发您的下一篇作品,就像您的文章可以为您的演讲提供动力一样。


了解你的受众

在开始写作之前,先想想你的读者是谁。他们是初学者、中级工程师还是高级工程师?根据他们的理解水平定制你的语言、内容深度和示例。

为初学者撰写文章时,使用清晰、简单的语言很重要。避免使用技术术语,以易于理解的方式解释复杂的概念。此外,提供大量示例和图片来说明您的观点。

使用视觉效果和代码示例对每个人都有好处,因为它有助于将抽象概念形象化,更容易理解。它还迎合了不同的学习风格。有些人是视觉学习者,这意味着他们通过图像和图表学习效果最好。


主题 !== 角度

一篇文章不可能涵盖某个主题的所有方面。如果试图这样做,可能会导致一篇 5,000 字的文章难以阅读。为了有效地解决你的主题,你必须选择一个角度——并坚持下去!

为了说明这一点,我们举一个具体的例子。例如,如果你想在文章中讨论 Python 测试,那么角度可以包括:

  • 历史角度:追溯过去十年 Python 测试方法的演变。
  • 实用角度:有效测试 Python 代码的技巧。
  • 反馈角度:回顾贵公司使用的 Python 代码测试方法。
  • 新闻角度:聚焦用于测试 Python 代码的最新库和工具。

有些人会把他们能想到的所有内容都写进博文中,而不考虑角度。他们认为越多越好,但事实并非如此。其他人则倾向于系统地选择相同的角度:反馈方法。嗯,有时这是讲故事的最佳角度,但并非总是如此。在开始写作之前考虑角度将节省您大量时间并使您的帖子更具吸引力。


明确

想象一下,在写博客文章时,拿起一根象征你想法的绳子,紧紧握在手中。不要把它掉在地上!

你应该始终确保写作具有连贯性。每当你切换想法时,你都必须清楚地解释原因。每一次。大声朗读你的文字对此非常有帮助。它让你能够识别思维过程中的差距或缺失的信息。

由于这是读者在看到标题后首先看到的内容,因此博客文章的介绍应该是最明确的部分。确保它提供一些背景信息,并解释目标受众是谁、你为什么有权撰写这篇文章以及读者应该期望从中找到什么。


花时间在标题上

您的博客文章标题将是读者首先注意到的内容。这才是让他们点击您的文章的原因(也可能不是!)。找到合适的标题非常重要,这应该是您写作过程中的一个单独步骤。您应该花时间在这上面,并让审阅者参与决策。要集思广益确定标题,ChatGPT 等工具非常有用。我的建议是提出三到五个建议供审阅者选择。

副标题也不容忽视。除了帮助文章结构化之外,副标题还有助于快速阅读。确保标题不要太笼统,尽可能描述性强,这样人们就知道接下来要读什么。例如,如果您在文章的某个部分中描述迁移计划的 10 个步骤,那么将其命名为“步骤”可能不是最好的主意。通常会有一个更好的副标题,例如“10 步迁移计划”。


时机是关键

为了选择最合适的角度来阐述你的主题,你应该考虑你所讨论的技术所处的阶段。你可以使用 Gartner 炒作周期 来帮忙(谢谢, 工艺记录,以获得启发)。本质上,该模型是一种图形化呈现,展示了特定技术的成熟度、采用程度和社会应用程度。

最常见的技术博客文章类别包括:

简单介绍一下你刚刚发现的一项新技术。

  • 您希望一年前或者大三的时候就知道的事情。
  • 解决您周围发现的痛点。
  • 关于技术实施的反馈。
  • 事后分析。
  • 对你最坚定的信念的解释。
  • 会议/会面的记录。

在这些博客文章中,有些与技术发展的某些阶段更相关。例如,在技术触发阶段和膨胀期望阶段之间介绍一项技术会更合适,而反馈则更适合随后的时期,因为该技术通常会受到谴责。生产力平台期通常是专家发布有关特定技术细节的帖子的最佳时机。


将同行评审纳入校对流程

让审阅者参与到博客文章校对过程中,就像您处理代码一样。无需让太多人参与这个过程 — 通常 2 或 3 人就足够了。为了有效地整合审阅者的反馈,请建立一个清晰的系统来跟踪和处理评论。使用协作文档编辑平台,审阅者可以直接在文档中留下评论。

此外,诸如 Grammarly海明威 或者 词调 可以帮助改进语法和可读性。这些工具可以发现人工审阅人员遗漏的错误,确保您的内容无误且易于阅读。它们还可以提供有价值的建议,以提高您的写作清晰度和连贯性。

最后,写完后休息一下,用全新的眼光重新审视你的博客文章。大声朗读你的文字可以帮助你识别在最初的写作过程中遗漏的任何不恰当的措辞。


这是你永远不应该写的结论

结论通常总结了文章中讨论的内容并讨论了接下来的内容。在写最后几段时,大多数人都很累,只想完成他们的文章。让我们面对现实吧,结论往往很草率。

首先,不要在结论部分加上“结论”这个副标题。只要有可能,最好找一些更有意义的东西。记住,结论部分将是读者最后记住的东西。所以,如果有一个地方可以让你发挥创意,给人留下深刻印象,那就是这里了!

Leave a Reply

Your email address will not be published. Required fields are marked *

近期新闻​

编辑精选​