Article Writing Guidelines

ToolsQA earned its reputation in the space of QA world because of its in-depth tutorials/articles so as a writer you have a great responsibility on your shoulders. We expect you to adhere to the following:-

  • Expectations
  • Article Writing Guidelines

 

 

Expectations

  1. You are expected to carry out detailed research like refer to books/online tutorials/ebooks/Udemy courses/YouTube videos and produce refreshing, engaging and detailed tutorials.
  2. Avoid writing long sentences as it adversely affects readability. More details can be found on the following link:- https://strainindex.wordpress.com/2008/07/28/the-average-sentence-length/
  3. Your articles will be reviewed by well-experienced industry experts. They will share their feedback/observations with you so as to bring it up to the market standards. 
  4. Our reviewers make a cautious effort to share their comments in a humble and polite manner so ask from you is to take their comments in the same spirit.
  5. Both (Writer and Reviewer) are expected to work as a team, maintain a healthy environment and contribute towards the success of ToolsQA.

 

 

Article Writing Guidelines

1. Give an appropriate title to the article

Screenshot-1

2. Write 3-4 introductory lines about the topic. Here are a few ideas which you may like to consider while writing introductory lines: –

    • Start the article with a problem statement and how given article is going to help in solving it OR
    • You can also start the topic with some humor

Screenshot-2

3. List all subtopics which you are going to cover in the article (just like an index of a book)

Screenshot-3

4. All listed subtopics should be – Bullet listed, Italic and Blue in color

Screenshot-4

5. Press “Enter” two times before the start of each “Heading”, be it “Heading 1”, Heading 2”……..”Heading 6”

Screenshot-5

6. Start your article with “What is….” heading. Usually, it is the main heading of an article so format it as “Heading 2”. And “Heading 2″ should not be made”Bold” .

Screenshot-6

7. If any keyword/technical word is appearing for the first time then highlight it in Bold and Italic

Screenshot-7

8. If you are explaining a certain concept in points then it needs to be – Bullet Listed, Italic, Blue Color

Screenshot-8

9. Try to incorporate at least one image in your article as it enhances the user’s reading experience. You can: –

    • Search for a relevant image on internet OR
    • Draw it on a piece of paper, click its photo and upload it in your article

We have professional image creators with us who will enrich the look and feel of the image shared by you and make it look more professional.

Screenshot-9

10. You are also required to add the “alternative text” to the image. For that you need to follow the below steps:

  • Put the cursor on the image.
  • Click on the “pencil icon” (as shown in the attached image)
  • And then Write “appropriate name” of the image.

Edit-option

Alt-text

It is important to give an appropriate name to the image as Google do not understands the image, it understand text.

11. If you have further subheadings in your article that need to be formatted as “Heading 3”, “Heading 4”, “Heading 5”, “Heading 6” then make sure

    • You press “Enter” couple of times
    • Format it as “Bold” and “Italic”

Screenshot-10

12. Write 3-4 conclusion lines before ending the article. You can also include a small sneak peek into your next article.

Screenshot-11

13. Insert “Featured Image” for the article towards the end.

    • Wondering – “What Is featured Image”? In layman’s term, you can consider it is a poster of the film which entices the audience to watch the movie. Here are a few points to be considered while selecting an image, it should be:
      • Relevant to the topic
      • Entice audience to click on it

We are not expecting you to spend time in creating an image, all you are required to do is:-

      • Search for a relevant image on internet OR
      • Draw it on a piece of paper, click its photo and upload it in your article

14. As soon as your article is ready for a review then select “Technical Review” from the drop-down and click on “Save”.

Screenshot-12

15. The reviewer will give his/her comments/feedback on the article in the following manner with you: –

    • Strikeout lines from the article which are not required
    • Give comments/feedback in red color
    • Move article to “Draft” status on WordPress

Screenshot-13

16. As a writer – you are expected to take following actions on the article: –

    • Remove strikeout lines
    • If you in agreement with the changes suggested by the reviewer then:-
      • Make changes which are suggested by the reviewer
      • Turn reviewer comments in green color
      • Make your changes in green color so that the reviewer knows what all changes are brought in by you.
    • If you have a doubt or difference in opinion w.r.t a comment shared by the reviewer and you are NOT taking any action on it then: –
      • Leave reviewer comments in red color only
      • Share your viewpoint in any color except Red, Green, Blue, and Black
    • Choose “Technical Review” from the drop-down and click “Save”.

Screenshot-14

17. The reviewer will go through the changes made by you

    • If okay with the changes
      • Remove his/her review comments from the article
      • Turn all changes brought in by you in black/blue color from green color
      • Move article to “Final Review” status on WordPress
    • If not okay with the changes – move to step 14

18. You will have to format all the examples as “Italic and Blue”. As shown:

Example

19. Whenever the writer specify any URL in the article, the URL should be “Bold and Italic” and should be of the specified “Blue” colour.

Blue

URL:

URL

20. The writer needs to mark the alignment of the image as “None”. For that, Click on the image and then on the pencil symbol as shown below:

Edit-option

And then mark the align option as “None”.

Alignment

21) Formattings, there are a few more formatting tips that need to be followed across whole site.

  • Anything which does not conclude a word in dictionary, make it ITALIC for e.g KeywordFunctionDefaultMode.HTML, SOmeMethod(), SomeClass{} etc
  • Anything that is specified within a bracket or quotes, make it ITALIC for e.g (Chrome, Firefox or IE), “Sample”, or ‘Lakshay’
  • Any abbreviation should be ITALIC as well for e.g. HTML, JSON, POJO etc
  • Anything that is BOLD, make it ITALIC as well, but not the other way around.

Leave a comment

Your email address will not be published. Required fields are marked *