preface

I think technical people write technical articles for three purposes.

  • Consolidate/improve your knowledge system
  • Let the reader obtain effective knowledge
  • Get likes, comments, followers

Of course, you have to do the first two first. This paper will analyze how to write a technical article from two perspectives.

Tech guy, what kind of knowledge do you think you’ve deposited?

For those of you who are front-end techies, take the knowledge module “front-end performance optimization” as an example (if that’s what you’re writing right now).

Here’s the question: How far do you feel you’ve settled in “front-end performance optimization”?

  • Level-0: a known trick on the web. For example, SSR, there are certainly many people do not know exactly how to do, but the vast majority of people have heard of it.

  • Level-1: Preliminary formation of knowledge system. For example, how to optimize requests, caching, static resources, etc. When you reach this level, you start walking in the advanced/senior direction. So if you happen to be at this level, think about two things first.

    • Article audience is in the advanced/senior advanced stage of readers.
    • How can you leave an audience with an audience.

  • Level-2: actual case. This is a much simpler understanding. For example, if you do a double 11 project, you are very clear about the business background, business bottlenecks, and technical bottlenecks. Then what you break through is the most valuable intellectual treasure of all. So at one level, you have three things to think about.

    • The audience is the advanced/senior/expert reader.
    • How can you retain readers above your level.
    • How can you leave behind readers who are not as good as you.

  • Level-3: Commercial solution design. The word may not be easy to understand. We know that there are industry standards behind many products. For example, how does the technical person behind Tmall Double 11 support the impact of high concurrency, and how to optimize the page performance for IOS and Android users? To put it another way, if a company wanted to hire you to support their business, how do you think you would design a plan that could be implemented and finally achieve the goals of the boss? So at this level, you only have one thing to think about.

    • How can you maximize your writing skills.

So, to what extent do you think you’re going to write this article? Think first about how well your knowledge of a particular area will translate into writing. Think clearly before you write.

Techie, what kind of articles do you think will get you to like

Readers’ psychological description of reading articles:

"Brush enough to 100 questions, protect you into XX factory" // yi? Good headline. I'm interested. Click inside to see // Huh? Here it is. I just need an article like this. Click inside to see // huh? !!!!! This isn't clickbait, is it? If it is, I'm not gonna turn him in! Click on it - browse the content for a while - // My god, this writer is big. // Learned, learned! / / yi? Why does the author say this is like XX? This is not what I understood! // I don't understand it, but it's awesome // Oh my god, it's clickbait. // The content of the main street, just baidu a lot of. Gone, gone... -- Finally at the end of the comment section -- // LET me ask the author what the point mentioned in the article means. // I have doubts, not mentioned in the article, @author to clarify. // Nothing to ask, but praise, writing is not easy. // Publish exclamation: enter the favorites folder eat ash! // 666. I feel that I understand something deeper, and I feel like admiring it. // It's like reading a novel. Must be thumb upCopy the code

Yes. To sum up, the readers who can stay in the comments section have experienced what kind of psychological process. Next we start writing articles!

The birth process of the article

  1. Decide on a title.
    • Requirement 1: The title can support the content of the article
    • Requirement 2: can have title party suspicion, but cannot be true title party.
  2. Please clarify the knowledge base that needs to receive your content. The higher the level, the more clear it is.
    • Before trying to explain something, a business, a technology stack, or a design, prepare your knowledge.
    • For example: if you’re designing a solution for a high concurrency scenario, you need to explain that you need to have some level of Node.js knowledge. There’s not enough space in this article to write why Node.js does X, but to presuppose that node.js does X, so you use it.

Real chestnuts:

Article Title: Knowledge Network, First Screen, Second on, Second on Indicator, Exception, Abnormal Indicator, Resource, Static Resource, Cache Resource, Disaster Recovery, Normal in extreme Scenarios, abTest Disaster recovery, Monitoring capability, Indicator Construction, Indicator Definition - Visual presentationCopy the code

The question is, why aren’t those performance optimizations mentioned? Obviously, most people know a lot about optimizations, but… Nothing more. To ask again might mean goodbye.

So, there is a very, very important point about technical writing: you have to have evidence for what you write! The short answer is to prove yourself. Back to yourself, you pile on and on, and people ask you: How do you prove that your scheme works?

Em…… The person who asks you that is usually your boss. You know.

So, you have to prepare arguments, arguments, and evidence for what you want to say. Take a popular example: a 40% turn-on rate per second, calculated by monitoring capacity. So, you find that you have to explain how your surveillance capabilities are built.

So, you optimize your knowledge network

Knowledge network - Computing Basis for building performance indicators - page first rendering time - WebView first startup time - page drivable time - user waiting time - user access times -... - Report data - Build performance monitoring Report SDK - Design exception report SDK - SDK Access design - Encapsulates the scripts previously collected on the first screen, blank screen, and stalled screen. And let the script run automatically. - Complete SDK usage/help documents to improve ease of use - complete a performance analysis assistant, which can quickly locate some simple basic problems - SDK operation design - compatibility problems, use native JavaScript to write performance indicator collection, achieve cross-end collection - fault tolerance mechanism, such as try catch capture, Then report exceptions - test SDK performance, confirm model distribution according to the actual use of users - report policies - Log data filtering - Filter data anomalies - Abnormal data includes calculation errors, legitimate outliers, maximum values, minimum values and so on. - Data sampling policy - Whether to report full data or sample data depends on daily activity. - General daily life less than 10W, can choose full. Live 1000W APP per day, then need to sample. - Select model for reporting - Logs are reported directly on strong networks. Logs are stored locally in weak networks and reported in strong networks. - Others include APP startup reporting, batch data reporting, etc... - Second opening rate indicator construction - through the reported XX data & XX data &...... Get the calculation result of second open rate - stability index construction - page exception rate - service exception rate -......Copy the code

All right. So you finally got the whole case and chain of evidence together, blah, blah, blah, blah, blah, blah, blah, blah, blah. You got the core code? Not much, just a drop (100 lines or less). Paste code.

So, that’s it?

  1. Hot creation, cold review

    For you, readers fall into three categories: people who get into your writing because they're curious. Like suspecting you're clickbait... 2: Blind, want to actively search for relevant knowledge information, but accidentally brush your article. But for you, you want to keep your readers. So, you can write novels, essays, love stories, or even sell dog meat in order to retain readers.Copy the code

Common faults of technical articles

- Difficult to understand, self-deprecating effect - poor typography, resulting in poor reading - long length, boring knowledge points. - It's not clear what the reader will gain from youCopy the code

  • So, long can. You can give the reader the option to skip and read only what the reader wants to read.

  • Obscurity, then, can become a psychological hint. For example, write: “To achieve XX effect, the code is as follows:”. Give the reader a hint that your code is the code that will help him implement XX, and please put the really arcane stuff in the code. Readers see the target, naturally willing to eat to see the code, see the bitter source.

    Please click on github addressCopy the code

  • Typesetting, really can not find their own like, then you can look at those hot articles, see how others typesetting

  • If you can, plan for foolproof success. For example, downloading your code will get you straight to the end result. If not, minimize the debugging cost.

Let’s talk again about how to view a technical article

I’m sure you’ve read a lot of novels. What are the characteristics of the articles that attract you to read or keep reading?

- framework. There are other terms, such as context, the big picture view of the world. Take, for example, the recent hit TV series Knives in the Snow. Why do the characters appeal to so many people? Because the world view, the setting of the characters, those virtual concepts (such as the Great Yellow Court) are very full. - the plot. No doubt, the story is not good, who will watch. But with all your technical articles, doesn't that mean there's no plot? You don't have to write a technical essay with a plot, but at least try to actively evoke a mood change in the reader.Copy the code

Let me write a simple example to explain it further.

I was late in the morning and my boss was as black as water. I think: this is not? The boss motioned me into the small conference room for a chat. "There is a big problem that they are not satisfied with the efficiency and quality of our development. Do you have a solution?" ... I made the XXX tool to improve the quality of development, the goal is to improve efficiency. The code is as follows:......Copy the code

Okay, you get the idea. In fact, summed up in a word is: you want to expose the overall view, you write a good overall view, want to expose the technical point, you write the technical point of flesh and blood.

Then summarize my personal ideas about writing.

  • A technical article is an article, or it is a paper.
  • Technical articles, in which any narration is auxiliary, are intended to highlight memory points. Can let the reader understand, comprehend, remember.
  • Write technical articles to precipitation, precipitation deeper, the higher the quality of the article. Quality + reader interaction = good content.

Last but not least, vote for me. Thank you very much! The popular author of the Year.