7 Checks before Writing Tech Articles

I have been writing tech articles for the past 5 years, mentioned below are few necessary checks before publishing an article. Feel free to add your own in the comments, look forward to learn from them.

1. Do not blatantly copy paste

Its okay to gather inspiration and ideas from works of other people, but its basic ethics NOT to re-publish someone else's work without prior consent/approval. Also, copying things reduces your credibility and does not brings in any uniqueness or authenticity to you or your work.

2. Mention the source

In case some information needs to be published, the source of the publication/content must be cited.

3. Differentiate between an article and a note to self

What you are drafting, is it an article to be read by others, or is it just your notes for yourself? Articles cater to the need of an audience, while notes are meant for yourself. In case you are writing notes, and want to publish it, mention it, so that the audience has an understanding, and basic expectations are set for him/her.

4. Picture your audience

It should be very clear to you, as to who you are writing for? Is the audience a Python Developer, if yes, then what is the level of expertise that you are looking for him/her. Its good to express what you know, but a catchy-expression is created keeping in mind the audience first. The reader should feel connected to the story, if not, the job is poorly done.

5. Describe your subject

Before writing, you should put in ample homework into the article that you are going to publish. You should write an article on topics where you have in depth knowledge and fluency to express the subject matter in detail. The author must ensure that all the steps mentioned work as shown in article, and are supplemented by ample information, so that its easy for the readers to connect.

6. Supplement with appropriate example and illustrations

Its good to supplement the article with appropriate examples and lucid illustrations. While thinking about examples, it must be taken care that examples are contextually relevant, and are easy to understand. If need be and you have resources, bringing out illustrations or animations go a long way while explaining the articles.

Eg. The following article makes understanding fourier transorm a breeze OR a visual explanation to list comprehension.

7. Basic Grammar and Proof Reading

Use of active voice should be preffered to passive voice. Active voice ensures directedness to the audience, and maintains the interest of the reader.

For example "Each cluster includes multiple nodes"(active voice) reads better than "In a cluster, multiple nodes are included."(passive voice)

Avoid using terms as "this", "that", "etc" unless absolutely required.

Use presen tense, and words like "will", which leads the reader to think about future than present. Writing in present tense, makes the language clear and unambiguous.

Proof Read an article and do basic spell check to avoid silly errors.

Hope the post helps!

Comments