Article Review Guidelines

While our writers leave no stone unturned when it comes to article writing but still being a subject matter expert, we look up to you, to help them produce even better articles for ToolsQA.

Being a Technical reviewer, you are expected to ensure that: –

  1. All facts are accurately covered in a given article.
  2. Articles are in line with the latest market trends. For instance, in a given article, a writer may have given emphasis on the Waterfall model but as a reviewer, you may want to him/her cover Agile methodology as well so as to serve fresh and latest content to our readers.
  3. You are also expected to share feedback with us about the writer aligned to you on a monthly basis. Your feedback may revolve around – 
    1. Are you happy with the research carried out by the writer? If no, then why?
    2. Does an article require multiple iterations? If yes, then why?
    3. Would you like to suggest measures which can help the writer to improve his/her writing skills?
    4. Along with the above pointers – you can also share strengths and growth areas of the writer

 

 

Article Review Guidelines:

1. An appropriate title has been given to the article

1

2. The article has been started with 3-4 introductory lines. Here are a few ideas which have been shared with the writers: –

    • Start the article with the problem statement and how given article is going to help in solving it OR
    • Talk a little bit about the previous topic and how the current article is related to it OR
    • Start the topic with some humor

2

3. After introductory lines – the writer is expected to list all subtopics which he/she intends to cover in the given article (like an index of the book)

3

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

4

5. Appropriate heading has been given to each section and the first heading of the article should start from “What is….”

5

6. If any keyword/technical word is appearing for the first time in an article then it must be highlighted in Bold and Italic

6

7. Relevant image (s) used in the article as it enhances the user reading experience. If you are not too convinced with the image then you can: –

    • Ask the writer to look out for a better image OR
    • You can search for a relevant image on the internet OR
    • You can 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 shared image and make it look more professional.

7

8. The article has been concluded appropriately towards the end

8

9. While reviewing the article – you will also have to ensure that articles are in line with the latest market standards and factually correct too. You have two options while reviewing an article

    • If changes are minor then
      • You can make changes on your own and finalize it
      • Move it to “Final Review” status on WordPress
    • If changes are major and you intend to re-route it to writer then follow below steps:
      • Strikeout lines which are not required in the article
      • Give your comments/feedback in red color. Please call out very categorically “what” you want the writer to include/exclude in the article. As a good practice – it is equally important to call out that “why” you are asking for those changes as it will
        • Broaden writer’s perspective
        • Give them more insight into your thought process and
        • Will be able to produce articles which are closer to your expectations in their next iteration
      • Move article to “Draft” status on WordPress

9

10. The writer will go through your feedback – post which there are two possibilities

    • The writer is in agreement with changes suggested by you so he/she
      • Make the changes which are suggested by you
      • Turn your comments in green color (indicates suggested changes are incorporated)
      • Make all the changes in green color so that you know what all changes have been brought in.
    • The writer has a doubt or difference in opinion and avoids taking any action until his/her doubts are clarified. In this case, he/she will: –
      • Leave your comments in red color only (indicates changes weren’t made by the writer)
      • Share his/her viewpoint in any color except Red, Green, Blue, and Black so that you know writer’s point of confusion
      • Post which, the writer will choose “Technical Review” from the drop-down, click “Save” so as to re-route it to you.

10

11. You are required to revisit the changes/comments made by the writer

    • If you are okay with the changes
      • Remove your review comments from the article (changed to green color by wrier)
      • Turn all changes brought in by the writer in black/blue color from green color
      • Move article to “Final Review” status on WordPress
      • As we need to share this article with our audience on LinkedIn and other Social media platforms so write 8-10 lines about the article, post it on JIRA and tag “Bhushan Bansal” in it.
    • If not okay with the changes – move to step 9

12. The writers need to give appropriate “alternative text”. You need to make sure that the text is appropriate.

It is important to give a correct and appropriate text name as google do not understand images. It understands text. So with the correct ” alternative text” google will understand the image.

Bring your cursor on the image and click on “Pencil” symbol.

Edit-option

Check whether the “alternative image” is appropriate.

Alt-text

13. You need to check that the examples are “Italic” and “Blue” in color.

Example

14. URL’s provided by the writers should be “Bold” and “Italic” and “Blue” in color.

The Blue should be as shown in the following image:

Blue

URL:

URL

15. You also need to check that the alignment of the article should be “None”. For that, click on the image and then click on the pencil option given on the image.

Edit-option

The below window will open, then click on the “None” option, as shown below:

Alignment

16) Formattings, there are a few formatting tips that we follow across the 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.
  • HYPERLINKS provided by the writers should be “Bold” and “Italic” and “Royal Blue” in color.

formatting-1

 

Leave a comment

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