[For Beginners] How to Write a Technical Blog? Explaining the Important Points

I'm Ito, an infrastructure engineer.
When a company is launching a new technical blog,
the most important thing, of course,to "write blog posts.

if they have never tried something like this before
I think there are probably some people who think "writing a blog is difficult"

So, this time I will explain how to write a blog that has also been deployed within the company!

Important points to remember when writing a blog

Write information, not a diary

As this is a technical blog, it's a given, but
when I think about what a blog is, I come to the conclusion that it's "to provide information."

For example, nobody wants to hear someone say, "I ate omurice yesterday," right?
Though, if it's a celebrity's daily life, that alone can be a topic of conversation.

People usually stumble upon technical blogs like thiswhen they're facing a problem.
Therefore, I believe they should contain information that can solve those problems.

So, if I were to write an article about "I ate omurice yesterday,"
how about writing something like, "I ate omurice at the currently popular Western-style restaurant called XX"?

In this case, the subject changes from "I" to "the shop."
This means that mentioning "I" won't solve anything, but
for someone who wants to know about shops, they can find out what kind of shops there are, which might lead to a solution.

This could be considered information

I hope that this blog will be able to help people in need

Consider visibility

There are two types of "readability" here.
The first is visual readability.

When writing, it's good to include information, but
what if that information is difficult to understand?

For example, writing it all on one line without any line breaks.
Let's condense the previous sentence into one line.

This is to be expected as it is a technical blog, but when I think about what a blog is, I come to the conclusion that it is to "provide information." For example, no one wants to read "I ate omurice yesterday." If it was a celebrity's daily life, that alone would be enough material. People probably come across technical blogs like this when they are in trouble. Therefore, I think that a blog should "contain information that can solve problems."

What do you think? It's hard to read, isn't it? It makes you lose the will to read!
Appropriate line breaks are really important.

Another important aspect is "clarity."
Since it's a technical blog, there will be a lot of technical terms, but it's crucial to explain them in an easy-to-understand way.

• Why did this happen?
• What led you to that conclusion?

If we don't write this clearly, the engineers won't understand..

The flow of writing is as follows:

1. I've had some trouble
2. So how do we solve this?
3. Why do that?

It would be good to keep these points in mind

And then the detailed techniques

, such as adding proper headings, using images in between, and not leaving URLs in Japanese...
but I'll skip those for now.

summary

As you can see, it's important to write a summary!

Especially with longer texts, it can be easy to lose track of the main points by the time you finish reading.
Therefore, it's helpful to include a brief summary at the end!

There are two important things to remember when writing a blog:

• Provide information
• Pursuing clarity

These two points form the basis, and then it's a good idea to add details (specific techniques) to them.
I'd like to include all sorts of information like this!

I have other articles written about blogging, so please take a look if you are interested

Three benefits of blogging

Tips for writing a blog steadily