Jira templates for user stories, task and bugs

Jira templates for user stories, tasks and bugs

No Comments

A recurring task in product management is writing user stories. In agile product development, a user story describes requirements for a product that are formulated from the viewpoint of a user. Therefore they become a key tool to work with requirements in agile teams.

In many companies, project management software (e.g. Jira, Asana, Monday, or Clickup) is used to collect user stories. Stories are documented as tickets.
Even though a central system is used to collect requirements, in many cases a common standard for the structure of user stories is missing. When different team members create a story, they will write it in their own way. This could lead to confusion or disorientation for the audience.

One solution approach is a template that defines a common structure for tickets. Every team member can then use the template and fill it with their own content. In this way, (ideally) all tickets follow the same structure. Team members and stakeholders can track them more easily.

Having worked as a Product Owner for many years, I created some templates that I used for various products. In this post, I want to share those templates with you. Feel free to use, modify or share the templates in any way.

Since Jira is widely used in the industry, I will provide the template for Jira.
Please note that Jira uses a different editor for Rich Text Formatting based on the Issue View you are using:

The templates are provided for both Issue Views.

Templates

User story template

Old Issue View

h3. (on) Summary
*As a* 
*I want to* 
*so that* 
 
h3. (*) Acceptance Criteria
{panel:title=Acceptance Criteria 1|borderStyle=dashed|borderColor=#17202a|titleBGColor=#808b96|bgColor=#fbfcfc}
*Given* precondition
*When* action
*Then* result
{panel}

{panel:title=Acceptance Criteria 2|borderStyle=dashed|borderColor=#17202a|titleBGColor=#808b96|bgColor=#fbfcfc}
*Given* precondition
*When* action
*Then* result
{panel}
 

h3. Design
 
h4. Link to Screendesign
[Links to your design system like Figma, Sketch,etc.|http://linkhere.com]

h4. Screendesign
Place Wireframes here
 
h3. Technical Information
Any link to technical documents, e.g. Swagger Documentation, Architectural diagram can be added here

h3. Additional Notes / Information
Any notes you took during refinement sessions or talks with other people about the story
 
h3. (flag) ToDo
(-) @ clarify

New Issue View

### :green book: Summary
**As a** 
**I want to** 
**So that** 
 
### :clipboard: Acceptance Criteria
/info panel
#### Acceptance Critiera 1
**Given** precondition
**When** action
**Then** result

/info panel
#### Acceptance Criteria 2
**Given** precondition
**When** action
**Then** result
 
### :paintbrush: Design
 
### Link to InVision
[Links to your design system like Figma, Sketch,etc.](http://linkhere.com)
 
### :floppy_disk: Technical Information
#### Link to technical information
Any link to technical documents, e.g. Swagger Documentation, Architectural diagram can be added here

### Additional Notes / Information
Any notes you took during refinement sessions or talks with other people about the story
 
### :flag on: ToDo
(-) @ clarify

Example

Example: Jira Template for user story

Next to the user story template I also like to use templates for tasks and bugs. For bugs, using of a common template is obligatory since it guarantees that all information is collected upon ticket creation. This helps reproduce the issue.

Task template

Old Issue View

h3. What needs to be done
 
h3. Why it needs to be done
 
h3. Acceptance Criteria
 
{panel}
*Given* precondition
*When* action
*Then* result
{panel}
 
h3. Additional Information

New Issue View

### What needs to be done

### Why it needs to be done

### Acceptance Criteria

/info panel
**Given** precondition
**When** action
**Then** result

### Additional Information

Example

Example: Jira Template for tasks

Bug template

Old Issue View


h3. Environment
* Device model:
* OS version:
* Software version:
* Browser version
* Stage:
* Account:
 
h3. Precondition
*
 
h3. Steps to reproduce
#
 
h3. Current behavior
*
 
h3. Expected behavior
*

New Issue View


### Environment
* Device model:
* OS version:
* Software version:
* Browser version
* Stage:
* Account:
 
### Precondition
*
 
### Steps to reproduce
#
 
### Current behavior
*
 
### Expected behavior
*

Example

Example: Jira Template for bugs

How to add the templates to Jira

Depending on the editor you are using in your Jira instance, the ways of adding the template to your Jira project differ.

Adding templates to Old Issue view

In your Jira project, create a new ticket and indicate it as the template in the Issue Title (e.g. “Template User Story”). At the bottom of the editor field, click on Text. Then paste the markdown from above in the form field. After you are done, click on Visual to see a preview. Other team members can then clone the ticket and fill it with their content.

Adding templates to New Issue view

As far as I know, you cannot copy and paste the code from here into the Jira New Issue View. It will not recognize it as markdown. Therefore you have to manually punch the markdown above into a new ticket. Jira will recognize the markdown and format it while you type.
After you have created the three ticket types, you can copy and paste the code into another ticket or clone the ticket.

You can use the templates in any way you want. Maybe you have some improvements for me. You can also share your templates in the comments. I am curious to learn how you structure your Jira tickets.

David supports codecentric as Product Owner and Product Coach in Hamburg. His main interest and experience is Product Management. He loves to develop products in a cross-functional team that provide measurable value for the user.

Comment

Your email address will not be published.