JIRA Document Guidelines

In this document we are going to cover following aspects:

  1. How to create/ access JIRA account.
  2. How to create ticket/task in JIRA.
  3. How to change status, Assignee and add comment in JIRA ticket.
  4. How to check tasks/tickets assigned to your name.

 

 

CREATING/ACCESS TO JIRA ACCOUNT

Step 1: As soon as you get access to the ToolsQA account, you will receive an email.

Invite-Mail

 

Step 2: Click on “Join them now” button which is there in the email itself.

Join-them-now

 

Step 3:  The link will redirect you to the ATLASSIAN page.

  • In the first text box your email ID will automatically pop-up.
  • Add user name( You can add any appropriate user name, preferably your first name)
  • Create password. (For a strong password use at-least one Capital letter, Special Character and Numeric value)
  • Click on Sign up.

Atlassian-page

 

Step 4: As soon as you logged in to JIRA, you’ll see this page.

JIRA-Home-Page

 

 

CREATE TICKET IN JIRA

STEP1:  If you are already logged in then start from step 2 else follow the given steps:

Atlassian-page

 

STEP 2: Click on the dots towards the left bottom corner of your screen.

Click-on-dots

 

STEP 3: Select Switch to “JIRA SOFTWARE”.

Click-on-JIRA-Software

 

STEP 4: Click on “Projects” and select “Content Writing Project”.

Click-on-Project-and-CWP

 

STEP 5:  Click on the “+” Symbol which is towards the top left corner of your screen.

Click-on-Plus

 

STEP 6: Add

  • Title of the article to “Summary”
  • Attachments (If any)
  • Leave the Due date blank
  • Description (Optional) – Brief write-up about the topic

Create-issue

 

STEP 7: Assign task/ticket to the individual who is working on it by clicking on the “Assignee” drop down arrow.

Add-Assignee

 

Step 8: Click on “Create”.

Click-Create

 

 

CHANGE STATUS, ASSIGNEE AND ADD COMMENTS

STEP1:  If you are already logged in then start from step 2 else follow the given steps:

Atlassian-page

 

STEP 2: Click on the dots towards the left bottom corner of your screen.

Click-on-dots

 

STEP 3: Select Switch to “JIRA SOFTWARE”.

Click-on-JIRA-Software

 

STEP 4: Click on “Projects” and select “Content Writing Project”.

Click-on-Project-and-CWP

 

STEP 5:

  • Go to “board
  • Select the article for which you want to change status/Assignee or add comments.

Select-article

 

STEP 6: Choose appropriate “Status” from the drop down menu which is displayed towards the top right of your screen.

Status

 

STEP 7: Choose appropriate assignee by clicking on “Assignee” text box.

Change-Assignee

 

STEP 8: Towards the bottom of the page, you will find an option to “Add a comment”. You can use this option to share an update with the writer/reviewer. You are also required to tag the person in your comments with whom you would like to share the update. Reason being, as soon as you tag an individual he/she will get notified. You can tag the person by using following syntax –
@Person_name.

Add-Comment

 

STEP 9: Click on “SAVE” after adding the comment.

Click-on-Save

 

 

CHECK TASKS/ TICKETS ASSIGNED TO YOUR NAME

STEP1:  If you are already logged in then start from step 2 else follow the given steps:

Atlassian-page

 

STEP 2: Click on the dots towards the left bottom corner of your screen.

Click-on-dots

 

STEP 3: Select Switch to “JIRA SOFTWARE”.

Click-on-JIRA-Software

 

STEP 4: Click on “Projects” and select “Content Writing Project”.

Click-on-Project-and-CWP

 

STEP 5: Click on “Board” and select “Assigned to me”.

Assigned-to-me

 

STEP 6: All the tickets which are assigned to you will appear here.

Ticket

You can also change Status, Assignee and Add comment from here, by clicking on the ticket/issue.

To know how to change Status, Assignee and Add comment click on How to change status, Assignee and add comment in JIRA ticket.

 

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

 

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.