How to write a technical article and talk about my views

Preface

Only a bald head can become stronger.

The text has been included in my GitHub Featured Article, welcome to Star : https://github.com/ZhongFuCheng3y/3y

I have always advocated that learning technology can write technology blogs to accumulate my own knowledge, because there are too many knowledge points, and my blog can help me quickly review what I have learned.

In the beginning, I only took notes, thinking that I could understand it. But if you want to verify that you understand, you can write a technical blog. In the process of writing a technical blog, I will definitely find: "I don't seem to understand this knowledge."

From the process of combing/writing, I will grow a lot

Many friends have asked me:

  • "3y how do you take notes? I watched the video while taking notes, ignoring my head."

  • "How do you think about your blog? I don't know how to blog"

image.png No technical blog/notes

Let’s talk about some of my views (personal/subjective). Everyone has their own methodology. My views are not applicable to everyone.

A picture of the opening, all content depends on editing:

image.png The content depends on editing!

1. How to write a technical blog

First of all, I believe that put himself as a sharer , and the reader is a white . Then simulate this scenario: if you want to share the techniques you have learned with Xiaobai, what do you need to do.

According to my thinking, I might do this:

  • First of all, you have to tell him what this technology is.

  • Next, why should I learn this technology, and what are the benefits of learning this technology. Is there any previous technology that is similar to this one? Why should I learn the new instead of the previous one? ( This step is very, very important )

  • Then, what is the core usage of this technology, give some small cases, let Xiaobai experience this technology.

  • Finally, what problems may arise with this technology, does the official provide a solution, and if not, what are the possible solutions?

In the vernacular, it is actually:

  • What is it

  • why

  • How to do it

Generally speaking, I will focus on  why   , because I always think that learning a technology must know: why you should learn it .

For example, I wrote the idea of [ Message Queue ]:

  • Looking back at what a queue is, Java already supports various types of queues, and how they are different from message queues.

  • Why use a message queue instead of it? What are the benefits of using message queues

  • Problems that may be caused by using message queues

If you encounter logic that may be more complicated, or think that the reader will not understand it, you can draw a picture to describe it, so that the entire article will not be too boring to read.

Actually, I write articles according to my own thinking. If I get stuck somewhere in the middle of studying, I think that maybe the reader will have the same problem while studying. Therefore, I will record my understanding and draw pictures to explain if necessary.

I have written more than two hundred Java technology blogs. Students in need can follow my GitHub . Welcome to learn and communicate together: https://github.com/ZhongFuCheng3y/3y

image.png Follow my public account and see how I write a technical blog

Second, the article needs to have its own style

Everyone writes a blog with their own style.

For example, there is a comic type : image.pngFor example, there is a story type :

image.png Storytelling

For example, those who have a showy air :

image.png Showy

For example, there are pure dry goods type:

image.png Pure dry goods

Having said so much, what I want to say is: blogging should have its own style. Instead of directly copying and pasting the information on the Internet, it will be over, so there is no emotion and no soul . (Of course, if there is indeed a well-written one on the Internet, you can do this, but it's impossible for the whole article to be the same)

Three, about typesetting

A good technical article is generally not bad in typesetting. I think there are several points in writing technical articles that can improve the reading experience :

  1. Don't 90% of the entire article is code, reduce the code appropriately , and paste the key parts. (The complete code can be uploaded to GitHub)

  2. Multi-section , technical articles may be relatively boring, if you squeeze the technical descriptions together, you may not have a good experience in reading

  3. Add icon description or insert related pictures

Programmers generally use Markdowngrammar when writing articles. If they are used appropriately, the layout of the article will naturally not be too bad. So Markdownstudents who have n't used grammar can use it as soon as possible. This thing is very easy to learn. It only takes a few minutes from learning to use.

  • My resume was Markdowngrammar...

image.png Four, about tools

I recommend the Markdown editor. It works Typorawell on both Mac and Windows. When using Markdown, there is definitely a question to consider: Which image bed is used ?

No matter which picture is used, it may hang. It may be safer to build a picture bed by myself (relatively more troublesome). I use 掘金the picture bed myself . And my articles are often distributed to several blog sites, like 简书/知乎this, the pictures will be uploaded to their servers separately.

Therefore, from my personal use point of view, I am not worried about the problem of hanging the picture bed. If you only send articles to one platform, you still have to pay attention to whether the image bed may fail. image.pngAs for which platform you post, I once wrote an article [ Which platforms can programmers choose to write technical blogs? ], the summary at that time:

  • If you don’t dislike 博客园the style, you can choose 博客园. Otherwise, it is recommended to choose: 掘金/ SegmentFault.

  • Just want to manage the articles I have written, choose:GitHub/GitBook

  • Like to toss: Hexo+GitHuborWordPress

It 流程图/思维导图/..can ProcessOnbe solved simply by using it.

At last

Some didn't talk a little bit, hoping to help some students who want to write a technical blog but can't start.

Two years of painstaking articles : "Interview Questions", "Basics" and "Advanced" are all here!

image.png More than 300 original technical articles Join the exchange group to learn massive video resources Exquisite brain map Interview questions

Long press to scan the code to follow to get 

Watching and sharing are very important to me!

It is not easy to create. Your support and recognition is the greatest motivation for my creation. See you in the next article! Seek likes and attention Seek to share and leave a message    


Guess you like

Origin blog.51cto.com/15082392/2590293