[对于初学者]我如何编写技术博客?解释要记住的要点
我是一名基础设施工程师。
当然,一家新公司开设技术博客需要的是“写博客”。
但是,如果您以前从未尝试过这种事情,
我认为有些人可能会认为写博客会很困难。
因此,这次我将解释如何撰写公司内部开发的博客!
写博客时要记住的事情
写信息而不是日记
由于这是一个技术博客,所以这只是自然的,但是
当我考虑一些关于博客的事情时,我得出的结论是,我认为“提供信息”。
例如,没有人会问“我昨天吃了煎蛋卷饭”之类的事情。
如果这是明星的日常生活,那已经是一个好故事了。 。
这些技术博客时遇到麻烦的情况。
因此,我认为应该写的是“它可以解决任何问题”。
所以...如果你要写一篇关于“我昨天吃了蛋包饭”的文章,
那么一篇关于“我在一家叫○○的西餐厅吃了蛋包饭”的文章怎么样?话题?
在这种情况下,主语从“boku”变为“shop”。
所以,即使我透露了我是谁,也解决不了任何问题,但
如果有人想了解这家商店,我想他们可以查出这是一家什么样的商店,这样就能找到解决方案。
这可以被视为信息。
如果您要这样做,我想成为一个可以帮助需要帮助的人的博客。
考虑观看的方便性
这里有两种类型的“易于阅读”。
首先是视觉上的。
编写信息时可以撰写有关信息,但是
如果难以理解,该怎么办?
例如,写一行,不换行。
将前一句话概括为一行。
这是很自然的,因为它是一个技术博客,但是当我思考什么是博客时,我得出的结论是它是提供信息的。例如,没有人会问“我昨天吃了煎蛋卷饭”之类的事情。如果这是明星的日常生活,那已经是一个好故事了。 。当您遇到麻烦时,您可能会访问这样的技术博客。这就是为什么我认为它应该有“可以帮助你解决问题的书面内容。”
你怎么认为?很难看到,不是吗? 。我没有心情读书! !
适当的换行非常重要。
另一个是“易于理解的”。
由于它是一个技术博客,因此有许多专用语言可用,但是清楚地写它们很重要。
- 为什么会发生这种情况?
- 是什么让您得出这个结论?
如果你不写清楚,工程师就看不懂……
写作过程是
- 我遇到了问题
- 那么我该如何解决呢?
- 我们为什么要这么做?
我认为牢记这样的观点会很好。
剩下的就是详细技术了
例如添加适当的标题,在中间使用图像,以及不要留下日语 URL,但
我将省略这些细节
概括
特别是如果文本很长,你读到最后可能不明白其中包含什么信息。
所以,最后写一个简短的总结会很有帮助!
写博客时这两点很重要。
- 提供信息
- 追求清晰
我认为使用这两个作为基础,然后充实它们(详细技术)是一个好主意。
我想发布很多这样的信息!
我还有其他有关博客的文章,所以如果您有兴趣,请看看。