preface
Many of you started your career by writing articles, yes, me.
There is no denying that good essays can help some students with less outstanding backgrounds score points in interviews, well, me too.
Today I’m going to share with my classmates how to write a good technical article.
directory
First, before writing the article
1. Define your goals
We usually write articles in two ways:
- Sharing: Provide quick access to developers with the same needs.
- Review: For review purposes only, I do not recommend Posting such articles to blog platforms.
Why don’t I suggest Posting the review on a blogging platform?
Because when we read such articles, sometimes we cannot understand the author’s intention, only the author can understand them. For such articles, my suggestion is to put them on a note-taking platform, such as Evernote.
2. Identify the genre
Common topics for technical articles are:
(1) Technology introduction type
It is used to introduce the latest technologies, such as Android Jetpack and Flutter, in the style of a technical document. After we have learned about a technology and had some experience with it, we can start an article, which is usually aimed at the lesser known of the technology. Take my Ready-to-use Android Jetpack:
Learn to Use Android Jetpack-Navigation
(2) Deep technology
This kind of article is usually an in-depth analysis of a technology from a principle point of view, aimed at a group of people who want to advance. Such as Guo Shen’s:
Glide Most Complete Analysis
(3) Problem solving
It’s usually a solution to a problem, and this kind of article is aimed at other developers who have encountered the same problem.
Two, in writing the article
Even if I know what to write, sometimes I don’t know how to write when my computer is turned on.
1. Write a headline
Let’s start with the title, which has the following requirements:
(1) The title should not be too broad
For example, if you want to write a series of articles about RxJava, you have ordered a “article to understand RxJava”, you have written a RxJava operator how to use, the following is guaranteed to give you a comment:
If we really want to make the title broader, what should we do?
The article can be written as a series, so as to ensure the length of each article, so that readers can read comfortably, but also to realize their own ideas.
(2) Avoid headlines
Read a lot of clickbait, like (no offense) : “With all the locks in Java, can you lock Thanos?” .
As a blogger, clickbait can be fun for a while, but if the content isn’t convincing, it can be blocked.
In the short term, a good title can improve reading, but in the long term, people will search for a lock article later. Can You lock Thanos compared to “Java locks?” , would rather see “Locking in Java [Principles, Lock Optimization, CAS, AQS]”.
So, we try to choose a short topic, and from the topic, we can see what we are going to introduce knowledge.
2. Use preface and table of contents
The purpose of the introduction is to tell the reader the general direction of the article, so that after reading the preface, the reader will know whether the article is suitable for them.
If you can, you can also make some catalogs using brain maps, like the ones in this article.
In this way, the context of the article is clear at a glance.
3. Make an outline
A good example is when introducing a new technology, like Android Jetpack:
Android JetpackWhat is?- Why use
Android Jetpack? Android JetpackWhich libraries do they correspond to, and the specific functions of each library?
Once you’ve written the outline, you won’t get stuck halfway through the article.
4. Writing techniques
I remember when I wrote a composition in primary school, the teacher often said, “If you don’t know how to write a composition, the total score is always a good method. For example, when we introduce a certain technology, we can write:
- Beginning (general) : What is this technology and what can it bring us? What are the main functions inside?
- Introduction (分) : How each feature of this technology is used.
- Summary (general) : The advantages and disadvantages of using this technology, and how it helps us in specific practice.
There are two ways to do this:
Ask the reader to think about the question at the beginning of the essay, and then, from the point of view of answering the question, how to solve the problem. Similar articles include:
How to calculate the memory size of Android Bitmap?
Pay attention to typography
Although some students’ articles have reached the technical depth, but the layout is not satisfactory, resulting in readers have no desire to read.
If your essay has the following:
- There are always large chunks of code or text.
- How many level headings are used depends on the mood.
- Chinese and English are not easy to handle.
- .
See Nguyen Yifeng’s:
Writing Specifications for Chinese Technical Documents
Of course, writing an article is not a technical document, you can make some changes according to your own needs.
Three, after writing the article
When the article is finished, don’t rush to publish it, because we still have some work to do.
Read the article from the reader’s point of view
Now forget yourself as a writer and consider yourself as a reader. Read step by step and see if you can master the techniques in the text. If not, you should consider how to improve the text.
2. Check the text
Wrong words, wrong sentences and English words are common problems, so when we have written an article, we need to read it at least once to avoid these silly mistakes.
3. Embellish it
If you’re tired of the style on your blog platform, it doesn’t matter. The Markdown(MD) format of both Nuggets and wechat official accounts supports HTML to help your posts look good.
For my kind of front-end dish chicken, HTML writing is impossible to write, is there a good way? Of course, you can use some third-party websites, such as Markdown Nice, which can help you automatically generate some beautiful styles, and then CV to the corresponding blog platform, this is how to operate.
Small talk about
If you have some good tips for blogging, feel free to discuss them below.
Finally, I changed the Id from the original TeaOf to nine hearts. Why did I change it? I thought the Id of TeaOf was not easy to remember, and then I wanted to change it to nine five. The name was registered, and finally I typed a word casually, and it became nine hearts.
Article quote:
Zhihu: How can a programmer write a good blog or technical article? How to Write a Good Technical Essay?