Guidelines for Technical Articles

Following are the basic guidelines to write any technical article (Java, Python, CSS, HTML,
JavaScript, C, C++ etc.) for tutorialspoint.com. If we find anything has not been followed as
per the guidelines, we will reject the article and get re-written to conform with the given
rules.

Current articles have taken lot of content from our tutorials. So we will need to revise many
of the existing articles following these guidelines and we will have to re-write all that code,
text and image content to make the content rich and useful.

Any article found violating the given rules will not be accepted and writer will have to write
it once again to conform to the given rules.

Rule 1 – Word Count

Every article should have a considerable amount of theory and short examples for teaching
purpose. We need to make sure every article should have 800-1200 words.

Though, we should not insert unnecessary, repetitive or bogus content to increase the number
of words.

Rule 2 - Opening paragraph

We need to give at least 5-10 lines of paragraph to setup the context of the article. A brief
overview about the problem statement, and how we are going to give its solution in this
article. This paragraph should start with the same keywords what we have in the article title.

Example:
Consider an article whose title is as below:
What are Integers in Java?

In this given article, we have main keyword Integers in Java, So now to start the opening
paragraph for this article we will proceed as follows:

An Integer in Java is a data type which is used to hold an positive or negative integer
value. An Integer in Java is a Wrapper class which provide more flexibility to Java
developers to manipulate the integers.

Rule 3 – Syntax
This is optional part but if you are writing an article on a concept which has associated syntax
to define, like a data type, a method, a class etc. then we should give it’s Syntax and explain
the syntax. For example for the above article following will be the syntax part.

Following is the syntax to define Integer variables in Java:

Integer obj = new Integer(int value);

Here Integer() is a constructor to create an Integer object obj initialized with the value
provided.

Rule 4 – Algorithms
This is optional but if there is a problem which we are going to solve in the article, then we
will have a section about its Algorithm. This section will give step by step procedure to solve
the problem. For example if we have to add two integers in Java then we should provide its
precise algorithm as follows:

STEP 1 - Declare two variables

STEP 2 - Take the input of two numbers.

STEP 3 - Apply the formula for addition.

STEP 4 - Add two numbers.

STEP 5 - Store the result in a variable.

STEP 6 - Print the result.

Rule 5 – Concept Detail

This part may or may not be available in the article depending on the nature of the article. If
article demands a concept then we need to give 2-3 paragraphs each one having 5-7 lines. If
required then we can divide this parts into different section using different sub-headings.

Rule 6 – Multiple Examples

We should strive to provide multiple example with output to cover different scenarios of the
concept. All the examples should be in running condition and not just a piece of code. Which
means we have to give end-2-end example which can be copied and pasted. We give two
liners explanation about the example explaining what exactly we are going to do in the
example.

Keep in mind, repeating same example with different values is not acceptable. For example
we can give multiple example for Integer in Java as follows:

Example (Create Integer using Numeric Value):

Example (Create Integer using String Value):
Example (How to convert Integer into int or vice versa):
Rule 7 – Example Code
Make sure you provide small code examples for learning purpose. For example if we are
going to write an article on Linked List then instead of giving a long and single example, we
should give separate examples about different operations like Inserting Nodes, Deleting
Nodes, Updating Nodes etc. in a Linked List.

We encourage to have every example less than 25 lines, if there are more number of lines in
any example code then those lines will not be counted while counting the number of words in
the article.

Rule 8 – Appropriate Headings

Make use of appropriate headings like Syntax, Algorithm, Example etc.

Rule 9 - Closing paragraph

You can provide a small concluding paragraph about the concept you have explained in the
article.

Rule 10 No Repetition, No chatGPT, No Plagiarism

We should strictly not to duplicate the content from tutorialspoint.com or any other website
or eBooks or books etc. Though you can take references from other websites and books, but
you will have to write content in your own words. This will save us from copyright issue as
well as we will be able to provide unique content instead of duplicate content.

You will also need to be very careful while using any image. If you need to make use of any
image then either you should draw your images yourself as a part of the assignment or if they
are complex images then let us know and we will design those images in-house.

There are number of tools available which can do paraphrasing for the given content, but
same time there are tools which tells us if the content has been paraphrased. The content will
not be accepted if it has been paraphrased.

Content copied form different websites, or books or Generated by chatGPT or paraphrased

content will be rejected and contract will be terminated with immediate effect.

Rule 11 – No Duplicate Text or Image

We should strictly not to duplicate the content from tutorialspoint.com or any other website
or eBooks or books etc. Though you can take references from other websites and books, but
you will have to write content in your own words. This will save us from copyright issue as
well as we will be able to provide unique content instead of duplicate content.

You will also need to be very careful while using any image. If you need to make use of any
image then either you should draw your images yourself as a part of the assignment or if they
are complex images then let us know and we will design those images in-house.
There are number of tools available which can do paraphrasing for the given content, but
same time there are tools which tells us if the content has been paraphrased. The content will
not be accepted if it has been paraphrased.

Rule 12 – Typos, Grammar etc.

Once you complete writing the article, before delivering it to the content manager, please do
a self-review to fix the mistakes and typos, grammars etc. Every article will be checked
thoroughly to make sure it has correct English Grammar, and sentence preparation.

Rule 13 – Usage of Screen Shots

We seriously avoid using any screenshot to show the output of any example. So all the
output should be in text format only. If it becomes really necessary where we do not have any
option to show the output like graphical result or something similar then only we will make
use of screen shots.

Rule 14 – Research & Development

Writing good articles is purely based on doing research on the given topic which includes, to
see what already exist on the internet, what are the things have been covered under the same
topic, what type of examples have been used to explain the concept. Based on all this
information, we design the structure of our article and then we write the content in our own
words. Though we can refer different websites, books, eBooks and other reference manuals to
collect the information about the topic, but at the same time we respect copyright of others
work. So no copy/paste or paraphrasing of the content will be accepted.