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

我叫伊藤,是一名基础设施工程师。
当一家新公司开始写技术博客时,
最重要的当然是“写博客 。
我认为有些人从未尝试过
所以,这次我将解释如何撰写一篇已经在公司内部部署的博客文章!
写博客时需要记住的重要事项
写信息,不要写日记。
这是一个技术博客,所以它的存在很自然,但当
我思考博客的本质时,我得出的结论是,博客是关于“提供信息”。
例如,没人想听“我昨天吃了蛋包饭”。
如果是名人的日常生活,光这一点就足以成为谈话话题。
人们之所以会浏览这些技术博客,是因为
他们遇到了问题所以我认为这些博客应该包含能够帮助解决问题的信息。
所以……如果你要写
一篇关于我昨天吃蛋包饭的文章,可以这样写:“我在一家叫XX的西餐厅吃了蛋包饭,这家餐厅现在非常火爆”?
在这种情况下,主语从“我”变成了“商店”。
这意味着即使你提到“我”,也解决不了任何问题,但
如果有人想了解这家商店,他们就能知道这是一家什么样的商店,这或许能带来解决方案。
这可以被视为信息。
我希望这个博客能够帮助到有需要的人。
考虑可见性
这里所说的“观看便捷性”有两种类型。
第一种是视觉上的观看便捷性。
写作时,写信息是可以的,但
如果信息难以理解怎么办?
整个句子在一行上,不换行
这在技术博客中是意料之中的,但当我思考博客的本质时,我认为它的目的是“提供信息”。例如,没人想看“我昨天吃了蛋包饭”。如果是名人的日常生活,那本身就足够吸引人了。人们通常在遇到问题时才会浏览这类技术博客。因此,我认为博客应该“包含能够解决问题的信息”。
你觉得怎么样?很难读,对吧?让人失去阅读兴趣!
合适的换行非常重要。
另一个要点是“易于理解”。
因为这是一个技术博客,所以会用到很多技术术语,但重要的是要用通俗易懂的方式来表达。
- 为什么会发生这种事?
- 是什么让你得出这个结论?
如果我们不把话说清楚,工程师们就看不懂……
写作流程如下:
- 我遇到了一些麻烦。
- 那么我们该如何解决这个问题呢?
- 为什么要这样做?
牢记这些要点很有必要。
然后是详细的技术细节。
注意事项,例如添加合适的标题、在中间使用图片以及不要将网址保留为日语,
但在这里我就不赘述了。
概括
尤其是读长篇文章时,读完后很难记住文章内容。
因此,在文章末尾写一个简短的总结很有帮助!
写博客时需要记住两件重要的事情:
- 提供信息
- 追求清晰
我认为最好以这两张图为基础,然后再添加细节(精细技巧)。
这样,我就可以发布各种各样的信息了!
我还写过其他关于博客的文章,如果您感兴趣,请看看。
1
