【面向初学者】如何撰写技术博客?讲解要点

我是伊藤,一名基础设施工程师。
当一家公司推出新的技术博客时,
最重要的当然“撰写博客文章

如果有些人以前从未尝试过写博客,他们
可能会觉得“写博客很难”

所以,这次我将解释如何撰写一篇已经在公司内部部署的博客文章!

写博客时需要记住的重要事项

写信息,不要写日记。

a0002_011009_m
由于这是一个技术博客,这是理所当然的,但当
我思考博客的本质时,我得出的结论是“提供信息”。

例如,没人想听人说“我昨天吃了蛋包饭”,对吧?
不过,如果这是名人的日常生活,那本身就可以成为一个谈话话题。

才会偶然发现这类技术博客在遇到问题时
因此,我认为这类博客应该包含能够解决这些问题的信息。

所以,如果我要写一篇关于“我昨天吃了蛋包饭”的文章,
不如这样写:“我在一家名为XX的、目前很受欢迎的西式餐厅吃了蛋包饭”?

在这种情况下,主语从“我”变成了“商店”。
这意味着提及“我”并不能解决任何问题,但
对于想要了解商店的人来说,他们可以查到有哪些类型的商店,这或许能带来解决方案。

这可以被视为信息。

我希望这个博客能够帮助到有需要的人。

考虑可见性

a055_000568_m

这里有两种“可读性”。
第一种是视觉可读性。

写作时,包含信息固然好,但
如果这些信息难以理解怎么办?

例如,把所有内容写在一行里,不要换行。
我们来把上一句话精简成一行。

这在技术博客中是意料之中的,但当我思考博客的本质时,我认为它的目的是“提供信息”。例如,没人想看“我昨天吃了蛋包饭”。如果是名人的日常生活,那本身就足够吸引人了。人们通常在遇到问题时才会浏览这类技术博客。因此,我认为博客应该“包含能够解决问题的信息”。

你觉得怎么样?很难读,对吧?简直让人失去阅读的动力!
合适的换行符真的非常重要。

另一个重要方面是“清晰性”。
由于这是一篇技术博客,所以会有很多技术术语,但至关重要的是要用通俗易懂的方式解释它们。

  • 为什么会发生这种事?
  • 是什么让你得出这个结论?

如果我们不把话说清楚,工程师们就看不懂……

写作流程如下:

  1. 我遇到了一些麻烦。
  2. 那么我们该如何解决这个问题呢?
  3. 为什么要这样做?

牢记这些要点很有必要。

然后是详细的技术细节。

,例如添加合适的标题、在文章中间使用图片以及不要使用日语网址……
但我现在先略过这些。

概括

bsPAK86_zetuboumachinami1145
如你所见,写摘要很重要!

尤其是对于篇幅较长的文章,读完后很容易忘记要点。
因此,在文章末尾附上简短的总结会很有帮助!

写博客时需要记住两件重要的事情:

  • 提供信息
  • 追求清晰

这两点构成了基础,之后最好再添加细节(具体技巧)。
我想把各种类似的信息都包含进去!

我还写过其他关于博客的文章,如果您感兴趣,请看看。

博客的三大好处

如何持续稳定地写博客

如果您觉得这篇文章对您有帮助,请点个“赞”!
2
加载中...
2票,平均分:1.00/12
754
X Facebook Hatena书签 口袋

这篇文章的作者

关于作者