Notes on writing technical articles

This article will briefly introduce the main ideas in [Reading Experience of Technical Articles] ( http://www.cnblogs.com/cj723/archive/2012/03/15/2396422.html) , and lay a good structure for writing articles by yourself in the future Base. The standard for evaluating a technical article is: **Let readers who meet the reading conditions, with a better reading experience, understand, learn, and even master the ideas or technologies that the article wants to convey**. Several principles, described below, serve this purpose.

## User positioning

Writing articles is a way to transmit information. The asymmetrical way of transmitting blogs creates information asymmetry between readers and writers. In order to alleviate the reading pressure caused by this asymmetry, articles need to be at the beginning. , which introduces the reader to the basics necessary to read the following content. If readers do not have these basic knowledge, they may encounter difficulties in understanding in subsequent readings. For readers with this knowledge, it is necessary to give suggestions for further in-depth study at the end of the article as a supplement, as well as list some references involved in the process of writing this article.

## Make good use of chapter entries

For some longer articles, it is necessary to make good use of logical structures such as chapter entries to reduce the reading burden of readers. At the beginning of the article, in addition to mentioning the basics, you also need a brief overview of what knowledge or skills the reader can learn after reading this article. No matter what kind of knowledge is explained, the knowledge itself and the way it is explained are equally important, from simple to complex, from the solution of simple cases to complex cases, step by step to increase external conditions, step by step to introduce new solutions to solve problems, The elaboration of knowledge is carried out in a progressive hierarchy, and the synchronous evolution of problems and solutions in the whole process can be separated by different chapter entries, so that readers can have a buffer time from reading logic when entering the next stage.
At the end of the article, it is necessary to repeat the main points and content of the article again, so as to echo the beginning and the end.

## legible language

Teaching is mutually beneficial. In order to clearly explain a problem and its solution, it is necessary to have a good understanding of the background of the problem and different solutions. Each solution is valuable in a specific scenario. This understanding reflects Can you explain it clearly and clearly in your own language. I still deeply remember an explanation about processes and threads that I saw in college. It said that a process is like a carriage, and threads are like a horse, and a carriage has at least one Only a horse can run. Different carriages carry different goods. Horses and horses, and carriages and carriages, can communicate with each other. I can't remember the exact source. When I saw this analogy, I was really shocked. The theoretical concept of operating system can have such a clever connection with things in real life. Only by deeply understanding the process/thread relationship and loving life , A person who is good at thinking can come up with such a subtle analogy, which is really easy to understand language.

## Words are not as good as tables, tables are not as pictured

In terms of content expression, text is not as good as tables, and tables are not as good as graphics. These three have their own focus on expressiveness, and need to be selected and used according to different scene needs.

## Respond to comments promptly

When you see a reader leave a message for you, it is not the attitude of a professional to hang on/ignore it. Whether it can solve his problem or not, you must give a polite reply. If you can solve it, give a solution suggestion, not yourself If you are within your ability, you should also give possible search directions, which is respect for others.

Guess you like

Origin http://43.154.161.224:23101/article/api/json?id=325382008&siteId=291194637