Jira task template
What needs doing, why, and how anyone can tell it is done. For work with no user story and no bug behind it.
The template
[Verb] [what]
- Priority
- Jira’s default
- Labels
- None
Description
What needs doing
[The work, and what is different when it is done.]
Why
[The reason, or the request or issue it comes from.]
Notes
- [Links, access needed, or people to talk to]
Done when
- [What must be true when this is done]
- Whoever asked for it has been told
Show it as Markdown
### What needs doing
[The work, and what is different when it is done.]
### Why
[The reason, or the request or issue it comes from.]
### Notes
- [Links, access needed, or people to talk to]
### Done when
- [ ] [What must be true when this is done]
- [ ] Whoever asked for it has been told
What a good Jira task template contains
Four things: what needs doing, in a sentence or two; why it needs doing; notes the person who picks it up will need, such as links, access or people to ask; and a short checklist that says when it is done. A task that changes a running system also needs its risks and a way back.
The summary starts with a verb and names the thing: “Renew the TLS certificate for the staging API”, not “Certificate”. Leave out what Jira already has a field for, such as the assignee, the due date or the priority.
When to use it
Use it for work the team has to do that users would not notice as a change: an upgrade, a renewal, a migration step, a clean-up.
If the work changes something for users, write it as a story. If it starts from something broken, it is a bug.
What each section is for
- What needs doing
- One or two sentences. If it needs more, it is probably more than one task.
- Why
- Six months later, the reason is the part nobody remembers.
- Notes
- So the person who picks it up does not have to ask.
- Risks and rollback Detailed
- For changes to running systems: what could break, and the way back.
Sections marked Detailed are not in the template above. Switch them on in the generator, where you can also edit the text and the checklist.
Jira task template examples
The same template, filled in by four different teams. Each keeps the four sections and changes only the words. Copy the template above and use these as a guide to how much to write.
Software team: upgrade a dependency
- Summary
- Upgrade the orders API to version 5 of the database driver
- What needs doing
- Move the orders API from version 4 of the database driver to version 5, and remove the compatibility code added for version 4.
- Why
- The vendor stops security fixes for version 4 at the end of the quarter. Their notice is linked below.
- Notes
- Vendor notice and the version 5 upgrade guide
- Needs write access to the staging database
- The reporting jobs use the same driver: check with whoever owns them
- Risks and rollback Detailed
- Connection pooling settings changed between versions. No schema change, so rolling back means deploying the previous build.
- Done when
- Running on version 5 in production for a week without driver errors
- Compatibility code removed
- Whoever asked for it has been told
IT and operations: renew a certificate
- Summary
- Renew the TLS certificate for the staging API
- What needs doing
- Request a new certificate for the staging API before the current one expires, and install it on both load balancers.
- Why
- When it expires, the test pipelines and the partners’ sandbox connections stop working.
- Notes
- Expiry date and the request form are in the certificates page on the wiki
- Needs admin access to both load balancers
- One partner pins the certificate: tell them a week ahead
- Done when
- New certificate installed on both load balancers and checked from outside
- Next expiry date added to the team calendar
- The partner and whoever asked have been told
Marketing: replace outdated screenshots
- Summary
- Replace the product screenshots on the pricing and features pages
- What needs doing
- Take new screenshots of the redesigned interface and replace the old ones on the pricing and features pages.
- Why
- The pages still show the old navigation, so they no longer match what new customers see.
- Notes
- Use the demo account, never a customer’s data
- Image sizes are in the design system
- Every image needs alt text
- Done when
- All screenshots replaced, with alt text
- Old images removed from the media library
- Product marketing has been told
HR and onboarding: get a new starter ready
- Summary
- Set up equipment and accounts for the new finance analyst
- What needs doing
- Order a laptop and set up email, chat and the finance system for a new starter, so that everything works on their first morning.
- Why
- Request from the hiring manager, linked. The start date is in the request.
- Notes
- Role and start date from the HR request; no personal ID numbers in this work item
- The finance system needs approval from its owner first
- Done when
- Laptop delivered and signed in
- Every account tested
- The hiring manager has been told
If the same onboarding steps repeat for every starter, they fit better as sub-tasks under one task. Our guide to Jira templates with sub-tasks shows the ways to do that.
How to make this the starting point in Jira Cloud
Jira Cloud has no issue templates as such. These are the native ways to get this text into new tasks, as Atlassian’s own pages describe them, and where each one stops. Our guide to Jira issue templates in Jira Cloud compares them in more detail.
Team-managed projects: a default description
Each work type in a team-managed project can have a default description. Atlassian’s recap on JRACLOUD-4812 gives the path: Project settings → Issue types, select Description, and write the default text. Paste the template there, under Task. It is one text per work type, for the description only, and it cannot contain a table (KB).
Company-managed projects: Atlassian’s workaround
Here the system Description field cannot have a default. Atlassian’s workaround gives a custom Paragraph field the template as its default value, puts that field on the Create screen in place of Description, and copies it into Description with a post function on the workflow’s Create transition. It works, but it changes a custom field, screens and a workflow, and each work type still gets one template.
Cloning a reference task
Keep one task that is never closed, with this template in its description, and copy it with ••• → Clone when you need another, as Atlassian’s Clone page describes. The copy’s summary starts with “Clone”, and the reference task turns up in searches and on boards like any other. Anyone who can edit it can change the template for everyone.
Automation after the task is created
An Automation rule can write the template into Description: the Work item created trigger, a condition on the work type, and an Edit work item action, as in Atlassian’s KB. It runs once the task exists, so the person in the Create dialog still starts from an empty description. Every trigger, condition and action that runs counts toward your Automation usage, and a rule on Work item created runs for every new work item, even when its condition says no (usage doc).
None of these lets people choose between task templates in the Create dialog: a short one for routine work, say, and a longer one with risks and rollback for changes to production. That is what an app adds.
Want this as a template people pick in Jira?
Issue Templates & Create Defaults for Jira gives each project a Templates page. Pick a template there and Jira’s own Create dialog opens with the summary, description with its checklist, labels and priority filled in. From version 2.9.0 a template can also set the assignee to the person using it, a due date a number of days ahead, and components. The person can change anything before creating, under Jira’s usual rules for required fields and permissions. Set a default template for a work type, and the Create dialog names it. The app writes nothing into a form by itself. It can also set custom fields (text, number, date, dropdowns and more), and it runs on Jira Cloud only.
To take a template from this page into the app with its formatting, paste it into an issue’s description, then, as a project or Jira administrator, choose Save as template from the issue’s ••• menu.
Questions
What should a Jira task template include?
What needs doing, why, notes for whoever picks it up, and a checklist that says when it is done. For changes to running systems, add the risks and how to undo the change.
What is the difference between a task and a story in Jira?
A story describes a change that someone outside the team would notice, from their point of view, with acceptance criteria. A task is work the team has to do that users would not see as a change, such as an upgrade, a renewal or a clean-up. Both can sit under an epic.
Can I make this the default description for tasks in Jira Cloud?
In a team-managed project, yes: set it as the Task work type’s default description in the project settings. In a company-managed project, the system Description field has no default. Atlassian’s workaround uses a custom Paragraph field and a workflow post function.
Can a task template add sub-tasks?
In native Jira, an Automation rule can add sub-tasks once the task is created, and cloning a task can include its sub-tasks. Issue Templates & Create Defaults for Jira can list sub-tasks in a template from version 2.7.0, and creates them in order under the new task.
Related pages
Or build your own in the Jira issue template generator, and see what Jira Cloud does on its own.
- Jira issue templates in Jira Cloud Default description · Automation · Cloning · Where each one stops
- Jira templates with sub-tasks The same children under every epic or work item, with and without an app
- Bug report template Steps to reproduce · Expected result · Actual result · Environment · How often · Screenshots and logs
- User story template User story · Acceptance criteria · Context · Out of scope
- Incident template Impact · Started · Current status · Timeline · Workaround
- Spike template Question · Timebox · Why it matters · Output
- Epic template Goal · Problem · Scope · How we will know it worked