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

My name is Ito and I am an infrastructure engineer.
When a new company starts a technical blog,
the most important thing is, of course, to "write a blog .

I think there are some people who have never tried something like this before

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

It's a technical blog, so it's only natural that it exists, but
when I think about what a blog is, I come to the conclusion that it's about "providing information."

For example, no one wants to hear, "I ate omurice yesterday."
If it's a celebrity's everyday life, that alone can be a topic of conversation.

The reason people come across these technical blogs is because
they are in trouble so I think they should contain information that can help solve the problem.

So... if you were to write
an article about how I ate omurice yesterday, how about something like, "I ate omurice at a Western restaurant called XX that's all the rage right now"?

In this case, the subject changes from "I" to "the store."
This means that even if you mention "I," it won't solve anything, but
if someone wants to know about the store, they'll be able to find out what kind of store it is, which may 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 "ease of viewing" here.
The first is visual ease of viewing.

When writing, it's fine to write information, but
what if it's difficult to understand?

the entire sentence on one line without any line breaks

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 interest in reading!
Appropriate line breaks are very important.

The other is "ease of understanding."
Because it's a technical blog, there are a lot of technical terms, but it's important to write 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

to consider, such as adding a proper heading, using images in the middle, and not leaving the URL in Japanese,
but I will skip over them here.

summary

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

Especially with long articles, it can be hard to remember what information was there when you finish reading.
So it's helpful to write a brief summary at the end!

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

• Provide information
• Pursuing clarity

I think it would be best to use these two as the foundation and then add details (fine techniques).
In this way, I would like to post a variety of information!

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