This article is intended for students who want to publish in the technical community such as Nuggets. Notes for personal writing are beyond the scope of this article. At the same time, I don’t think anything written for individuals should be out in the community.

There are so many reasonable content technologies to choose from, which one is suitable for writing and which one is not?

Common content suitable for writing are:

  • Emerging technologies
  • Methods of problem solving in engineering
  • Analysis of profound problems
  • Important details that most people miss

The scope of the content of the article should not be too large, writing large and complete things for the level of the author is very high and need to consume a lot of energy. If you really want to write, please first clear your mind and communicate with experienced people before writing.

A quick tip: Before writing an article, do a search engine search on the topic you want to write about to see if you are confident that you can beat what you already have. If you don’t have an article, start with an entry-level content and work your way up based on community feedback.

Make sure the content is accurate

What I choose to write is mostly what I know, but there may be some ambiguity in the details. Note that your ambiguity is also the motivation for many people to read this article. Be sure to refer to the literature to clarify this! But don’t get bogged down in detail. It’s good to be able to explain the context (more details are for another article). In addition, similar selection, comparison, trend of a class of articles, the overall grasp of the industry is also very important, before expressing their own views, should fully understand the views of other people, especially their views.

Writing skill

Technical articles are characterized by rigorous logic and clear hierarchy. Therefore, before writing, you should first make an outline, according to the level of content from the easy to the deep.

Most of the technical knowledge can be explained in code, so be sure to post the code here. The code should be well-structured, logical, and articulate. Some critical code needs to be clearly commented. If you have a demo, you can put a link to the demo.

The first paragraph of your essay should be clear about the audience you are writing for and what you need to know in advance. It is best to summarize the content of the article in 2-3 sentences.

The choice of words is also important. Ask a question before you dive into the details. If you want to talk about matrices, you can ask: What is a matrix? And then I’ll introduce you to matrices. This can lead readers to think and keep up with the author’s writing thinking.

When describing advanced content or details, do not use proper nouns, even if they have already been explained. Try to use the vernacular or analogy to explain the problem clearly. If the text is not clear, please draw a picture.

The layout

I believe that most technical people have mild cleanliness, so the layout of the neat and indent without much to say. Here are a few tips to freshen up the layout:

  • Replace “” with” “
  • There is a space between English and Chinese. Like juejin. Im.
  • There is a blank line between paragraphs
  • Code blocks must be rendered.

The title

Uc-style headlines can be catchy, but technical articles are written for people who have been on the Internet for a long time and are already resistant to shock. Be pragmatic and let the reader have a general idea of what the article is about based on the title. You lose reading in the short term, but in the long run, it’s a great way to build your personal brand.

conclusion

In general, a good technical article needs to have

  • Simple and unpretentious title
  • Something that is not easy to repeat
  • Accurate content presentation
  • Detail description is clear
  • Good formatting and typography

Once you have written it, read it through. Put yourself in the reader’s mind and consider whether you can understand the article without having learned what you learned to write it.

Writing an article is a very mental, physical and time consuming thing. Before you start writing, Think Twice ~

In addition, writing articles in nuggets can be exchanged for 100 yuan of good books.

Thanks: @waiting for you @zw. Will @sunshine xiaoqian @Zimo @axuebin @Tianfang Night @Emo suggestions for this article.