这是8年零700篇文章后我撰写技术文章的主要技巧

自2009年12月26日起,我定期在此Blog上撰写有关各种技术主题的文章。 可以说我有很多技术写作实践!

我喜欢学习,也喜欢分享。 我喜欢通过写作分享我所学到的东西,因为它也有助于我巩固自己的理解。

在过去的3个月中,我的帖子每月在该媒体和该博客上获得约75,000次浏览。 因此,有证据表明,我的著作至少没有使读者流连忘返!

因此,为了帮助更多的人分享他们的知识和见解,这里有一些我编写时遵循的简单规则。

注意“专业知识的诅咒”

最重要的经验法则是始终记住您 您所在领域 的专家 当您分享知识和经验时,您需要注意您对读者的假设。

特别是当您讨论一种方法的优缺点时。 始终明确地陈述您的假设和背景。 这有助于读者了解您为什么这样做以及使用的限制。

西蒙·西内克Simon Sinek)不朽的话说,从为什么开始,这使我们进入了下一个要点。

就像“华尔街之狼”中的那场大场面一样, 迪卡普里奥(Di Caprio)要求乔恩·伯纳塔尔(Jon Bern­thal )卖给他一支笔

创建需求,然后提供解决方案。

把问题卖给读者。 帮助他们了解为什么这是一个值得解决的问题。 解决方案的优点无关紧要,没有一个有趣且值得解决的问题。

在可能的情况下,我尝试确定“好”解决方案的外观以及应具有的属性。 在描述了解决方案之后,我将完成必须进行的权衡 。 这通常会围绕成本复杂性和 效率的支柱发展

如果您没有预先定义“好的”是什么,那么认知偏差就很容易蔓延。我们经常下意识地弯曲“好的”的定义以适合我们的解决方案,并在此过程中失去客观性。 我们都有这种确认偏见,这是无法回避的。 但是提前定义“好”有助于使我们对自己诚实。

请记住,您的解决方案可能仅在特定情况下有效。 如果人们在不了解您的解决方案的工作环境的情况下采用您的解决方案,那么他们就有失败的风险。 更糟糕的是,如果失败还不够明显,那么您可能已经开始了另一起货运活动。

简短一点

在中等水平上,您可以看到您的帖子阅读需要多长时间,并且有多少人开始阅读它。 毫不奇怪,很明显的趋势是,较长的帖子的阅读百分比较低。

我为与无服务器相关的帖子统计了数据,这就是我所看到的。

这也反映在我的个人阅读习惯上。 我往往会在几个坐姿中完成更长的帖子,因为我经常会在中途失去注意力。 即使我真的参与其中,我也很少能够一次坐满长篇文章。

这对您来说意味着您应该使事情简短,有力且切题。 不要流连忘返,并尝试以N级来解释事物。

如有必要,请使用要点,并将每条保持为一行。

写这篇文章,然后再读几次。 每次运行时,都切出不必要的单词或改写句子,以使其更加简洁。

例如,“是或不是,这就是问题”可能含糊其词,给读者留下了很多。 更长,更扩展的版本实际上还不清楚!

说实话

不用说😛

图片说一千个字

运用常识,太多图片也不是很好。

另外,保持图片相关。 我们都喜欢猫的图片,但是其中太多(或用在上下文之外的图片)已经搁置了。

开始坚强

在进行演讲时,我也会遵循此建议,并尝试启动演讲或发表强烈的信息。

将读者的注意力范围视为一种货币。 您必须先吸引观众的注意力,然后才能将他们用于技术讨论。

结论

就是这样,每当我编写时,我都会遵循6条简单的规则。 自由代码营的人们也对在媒体上写作有一些很好的建议。

希望这篇文章对您有所帮助。 如果您对我如何改善自己的写作风格有任何建议,请随时通过以下评论告诉我。

祝大家东人快乐!