How are technical articles made?

Mind Map

I have seen many Article I thought about it. What kind of technical articles do I think are good? This article is mainly written to myself and will be helpful to my later technical articles. Target group

It's not for you to write it at the beginning of the article. What kind of person is your article suitable for reading? -- What does this mean? despise me for not reading your article. The "target group" I am talking about is everyone, including yourself. Your articles are for everyone and for yourself. We are honored to be able to read your article. The Internet is an age of information explosion. I have no articles. I can read your articles. If someone cares about you, shouldn't you be glad? If you can write comments to you when reading your article, you should be happier, because people have read your article. And if you have some suggestions, you should be more happy. Because you got unexpected gains.

 

Simple and clear

The article you wrote should be as simple and clear as possible. -- To write technical articles, you should simplify the complicated content, rather than the complicated content. After all, it is not a book. Many "cool people" are very cool and cool. They write articles like the cloth of old women, which stinks and grows. -- Sometimes I often make such mistakes, although I am not a "cool man". So how can we make it simple and clear? 1. Just show us the theme sentence (key sentence) and write a bunch of nonsense. -- A lot of people can explain things clearly in one sentence, and use hundreds of lines of words to make people understand. This also shows that he is also confused. 2. You can add up to four sentences. -- If there are more than four sentences, it means that you are still confused, and you need to "refactor" to shorten the content as much as possible. -- After all, you have time to read, but don't waste your time. 3. Extract theme meanings from images. If your graph can describe your problem, you can use the graph to represent it and add some auxiliary text instructions (this is what you did not understand) 4. Technical Terms give a connection. -- Many people write articles with a special feature. When talking about a technology, what is this technology first? Do you want to say this? Which of the following is not clear about Wikipedia? You only need to connect to it. Sequence

You 'd better move your most important and important items to the front row. -- After all, no one will read your article. Everyone is busy. What else do we need to do? How can I read your entire article. I remember when I wanted to read some technical books, I was very eager to buy related books at the beginning. As a result, I read the first two chapters, so I had no idea how to read them later, I usually spend half a year or a year reading this kind of book. After all, I am at a loss if I try my best to make money. However, I found that many books that I was not interested in at the beginning, the more I became interested in the future, the more exciting the future, and the more I learned in the future. -- Why is it so difficult to learn something useful? Brief

Your article should be as short as possible. Reading long articles is as daunting as reading long functions. If your article is long enough to explain the problem, I suggest you make the article into a series and share it with you in several series. Every time you look back at it, it is more targeted. -- This should be written with us. Code Similarly, do not make your class too long. If it is too long, you should refactor -- extract class. Reconstruction

Don't think that you can write your article in a short time. You are not perfect. Even a good writer, you have to constantly modify his article? What's more, you're just a coder? After writing an article, we need to read it regularly. The process of reading the article is another learning process. We often find some problems. Such as punctuation marks, typos, code errors, language errors, article styles...

Try to configure some images. In most cases, the images are very informative. -- If you can configure an animated video, it will be even better. In many cases, the problem illustrated in the diagram cannot be compared with the text.

Accurate

Do not be afraid of incorrect opinions or technical mistakes. If someone corrects them for you, go to the materials to check and correct them, you can also learn a lot in the middle. Don't be afraid of mistakes-are brave and invincible! Summary I know that many people may vomit blood and make bricks after reading my articles. So, what about the shoot? Beat me.