Why write a technical blog?

There are many articles online that talk about why a programmer should regularly write technical blogs.

In general it can be the following three issues:

Help life

Obviously, you do not write technical blogs to share pompous things like narrating your love story with a bear, or reporting to the netizens how sad you are today because it is always sun-resistant.

You write a technical blog to share your knowledge and knowledge with people who don't know.

Screen Shot 2016-09-07 at 5.47.04 PM

If you have not figured it out yet, then remember the white waking nights looking for a sample project, because you have been soaking for months without doing it, but tomorrow is going to be paid :)) You will feel grateful to the unsung heroes. put everything you need online, help you get through the life of students playing online … Oan injustice. The time has come for you to do the same for the postpartum class.

Help me

Five strong knowledge

I am very afraid of being bricked, so every time I write, I have to learn a lot about the topic I write, and sometimes to write an analysis for a technical concept, I have to read to 4 , 5 articles or rummage through each book …

And of course this only benefits me. After completing the article, I gained a fair amount of knowledge about the problem I wrote and related issues. This is also an effective way to learn any technology.

Unfortunately, writing articles is still eaten brick as usual …

Enhance English ability

When I was in high school, there was a period when I studied C ++ by translating the articles that instructed me to use a game engine and posted on Vietnamese forums to share. As a result, my English score from grade 30 jumped to the top 10 of the class: v

And what I did not expect was that this skill helped me a lot in the years of studying IT later.

Have an opportunity to verify knowledge

If you know something, without saying it, no one knows you understand it. Or worse, you will be mistaken for understanding it until you get questions or suggestions from readers …

Write and receive questions, criticisms, brainstorming thoughts or head into research to answer those questions, in the end you really become a formidable hand because of the growing knowledge. What are you waiting for? ?

Famous …: v

In fact, I don't mean to bring this fame-driven engine to seduce you. It's just that, if you are active, sharing, you will have the opportunity to know lots of people, and many will know your abilities.

What is technical blogging?

There is no standard formula or method for me to force you to follow.

How to write is depending on the preferences and experiences of each individual.

In this article, I will share with you my writing experience, of course for reference only, because it may not be suitable for you …

Step 0: Read

Screen Shot 2016-09-07 at 5.48.01 PM

To write a technical article, the first thing you need to understand is that, if not, you will get a large amount of stone tiles, and the article will not have a value.

Find ways to read a lot of articles about the problem you're about to write, analyze its pros and cons until you're confident enough to go through the next step.

Step 1: Make outline

In the past, I went to school to learn, everyone learned through writing, and remember that the teacher always made us outline for the article to be written. I have never done so at school, so my grades are often very low: v

Later on, when I joined writing, I gradually realized, outlining is a very effective tool. You absolutely can write a blog post / article without having to outline it, if the ability to control your content is good, otherwise, when you read the article again, you will not understand what you are writing about, don't mention readers =))

Screen Shot 2016-09-07 at 5.48.28 PM

First, you need to prepare:

  • A drafting software, if you like, can use Sublime, Atom or Evernote, Medium is also an option because it has a very neat interface.
  • Or a notebook and pen.

To outline, we have 2 ways: Writing or Drawing

This is how to make an outline by writing:

Screen Shot 2016-09-07 at 5.48.51 PM

And this is how I usually use it to outline, that is to outline the idea of ​​a notebook:

This is the step that you need to systematize the content you will be writing, after you have laid out the outline in a general way, you can drill down into a few smaller bullets to implement the idea for each content.

Step 2: Write

In this step, you simply start working on writing, writing, writing and writing.

If you have laid out the outline in detail in step 1, then this step is almost as simple as adding the text to your outline frame.

The important thing in this step is to present the content in a brief, easy-to-understand way, not so long.

This step we do not need to care about presenting the content, just write down the door. If using text editors like Sublime or Atom, you can choose to write using Markdown (then use the tools to convert to HTML later). The layout of the workspace on your favorite text editor is also a way to stimulate writing. The picture below is my workspace when writing articles for Kipalog using Markdown ?

Screen Shot 2016-09-07 at 5.52.10 PM

Style is also an important factor, writing style, using words will be your brand. I like how to write rustic, non-formal, like talking directly to readers. Although fastidious people will think that it is not respectful to readers, this way of writing will make it easier for readers to grasp the problem than languages ​​such as textbooks.

I influenced this writing by doctors Le Hoang, Pham Hong Phuoc, Hoai An. If anyone has ever read the magazine eChíp , Making friends with computers in the years 2003 – 2008, 2009 will surely miss their close writing style, true to the slogan of the newspaper: "Informatics as ordinary people"

Step 3: Present the content, add illustrations

After writing the door drop in step 2, we go into the preparation stage.

Present the article clearly, it is best to use large font and easy to read. Don't do anything fancy.

Check each space, show indentation, number the list items, bullets at the places listed.

Bold or highlight keywords, menu item names, class names, or the names of the characters mentioned in the lesson, …

Screen Shot 2016-09-07 at 5.52.33 PM

The selection of illustrations is also quite important. Should choose simple, less cumbersome, less colorful images, it is important to match the blog site interface you are writing. Carefully insert into the article, avoid causing it to burst. Images should upload straight to your blog page, avoid hot links from outside to prevent the original link from being lost, the article also loses value.

If you have the ability to draw, self-drawing illustrations will also create an impression for readers about your blog.

Screen Shot 2016-09-07 at 5.52.59 PM

Inserting multiple images will make the article more clear. Inserting too many images will make the article more messy. How much is enough? This is an art subject :))

Syntax highlighting for the code is also quite important, to avoid annoying readers because they cannot distinguish the code, the content of the article.

Final advice

Finally, in order to write a quality article, you have to have a logical content structure, a not so dry tone, visual illustrations, and meticulous presentation.

Please read your article several times before clicking Publish

Screen Shot 2016-09-07 at 5.53.18 PM

Happy blogging ^^

ITZone via Kipalog

Share the news now