Child pages
  • JIRA Authoring 101

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Make sure it has complete information for it to be addressed.  If not, add information in the Description and/or Testing Steps.

  2. Start watching it.

  3. Add a Comment to let others know you’ve experienced it too (you can also provide information in comments if it does not belong in the Description or Testing Steps).

  4. Link to related issues by selecting the More menu, then Link.  Search for and select or enter the JIRA numbers (e.g. SAK-#####) to add related jiras.  Links are extremely helpful to ensure that people can find the information they need in JIRA and most importantly, when fixes for several issues need to be applied together, they are all included!

  5. Select Vote for this issue to vote for it.

...

  1. Pretend you are explaining to someone who is coming to Sakai (or your tool) for the first time.  Be as thorough as possible!

  2. Use a numbered list for the steps.  If authoring in Text, enter # with a space after it on each line to make a numbered list item.

  3. If it isn’t obvious, indicate the desired behavior also for bugs (what should happen when fixed?)

  4. If you added attachments, insert them where appropriate (it really helps to have a screen shot inline with the text!)  If authoring in Text, place the attachment name in between two exclamation marks, e.g. !screenshot.png!  For large screen shots, you can embed a thumbnail image, e.g.: !screenshot.png|thumbnail!

After Creation

After creating the jira, Link to related issues by selecting the More menu, then Link.  Search for and select or enter the JIRA numbers (e.g. SAK-#####) to add related jiras.  Links are extremely helpful to ensure that people can find the information they need in JIRA and most importantly, when fixes for several issues need to be applied together, they are all included!