Jira is getting a fresh new look and navigation

We’re in the process of rolling out these changes and the documentation may not match your experience. Bear with us while we update it to reflect the new changes. More about navigating the new Jira

Add files, images, and other content to describe a work item

Once you've created a work item, it's important to add enough detail to it to make sure whoever's working on it can resolve it as quickly as possible. Images, files, diagrams, support tickets, and other details all help to provide a clear picture of the work that needs to be done.

As you'd expect, you can add content like images and files from your computer, but you can also source and update content from external services via Atlassian Marketplace apps. Here are a few common ways you can add content to work items to create a richer picture for whoever's working on it.

The Free plans for Jira Cloud and Jira Service Management have a file storage limit of 2GB per product. The Standard plan allows up to 250GB per product, and file storage is unlimited on Premium plans. Read more about Jira Cloud plans.

Add a description

A complete description on a work item can save a lot of time in the long run. If you or a teammate come to a work item, but don't really understand what it's about once you're there, it can mean chasing down the creator and asking lots of questions. A good description means the assignee can start work straight away and get it done faster.

A description can include rich text, code snippets, images, tables, and more. The editor converts things like links, code, and markdown on-the-fly, so you can paste in your content and let the editor do the work.

Common markdown formatting options:

  • ## for H2 style (we support H2–H5)

  • **bold** for bold

  • *italic* for italic

  • ``` for a code block

  • [this is link text](www.atlassian.com) for this is link text

  • * for bulleted lists (like this one)

  • 1. for numbered lists

  • [] for action items

Mention your teammates

If you need someone to know about a work item, but you don't plan to assign it to them, you can mention them in it. Type @ followed by their name, then choose the right person from the list. The person you mention will be notified and can quickly jump to the work item to see what's happening.

Improve description using AI (beta)

AI is available and automatically activated for all apps on Premium and Enterprise plans. Organization admins can manage AI preferences from Settings > Atlassian Intelligence in Atlassian Administration.

AI is not available in Atlassian Government organizations.

 

AI can assist in generating work item descriptions when you simply paste Confluence links into Jira. By using the context from the Confluence link placed in the description field of the work item, AI creates structured content to improve the description.

To generate work item descriptions:

  1. Paste a Confluence link in a work item’s description field. If a Confluence link is already present, edit the description field.

  2. Select Improve description.

  3. Once the description is generated, select either Insert below or Replace to update the work item description.

Attach files and images

To attach a file to a work item, open the work item and drop the file on it. Alternatively, from the quick-add buttons under the work item summary, select Add and then Attachment. You can also drop or attach files in comments and other long text fields.

To link to files from services like Dropbox and Google Drive, paste a link to the file in the work item description, comments, or any long text field. We'll add a smart link that'll always refer to the latest version of the file.

Attached files haves some conditions:

  • File names can't contain any of these characters:  \ / \ " % : $ ? * .

  • By default, the maximum size of any one file is 10MB, but your Jira admin can change this limit.

The Free plans for Jira Cloud and Jira Service Management have a file storage limit of 2GB per product. The Standard plan allows up to 250 GB per product, and file storage is unlimited on Premium plans. Learn more

Confluence pages can add a huge amount of context to a work item without the need for huge descriptions or comments on the work item itself. And Confluence comes with handy built-in templates to help you get started, like product requirements and retrospective.

Read more about Confluence.

One of the easiest ways to link a work item and a page is to paste the link to the work item on the Confluence page. The work item link is automatically created, and you'll get a handy link to the page on the work item.

  1. Open a work item.

  2. From the quick-add button at the top of the work item, select Add.

  3. Select Existing Confluence page. If the page you want to link to doesn’t exist, select New Confluence page.

  4. Choose from recently visited pages or paste in the link to a page.

Once you link a Confluence page to a work item, both the work item and the page will show a link to one another making it quick and easy to switch back and forth between them.

You need a Confluence license to link to Confluence pages. Try it free if you aren't using Confluence already.

AI is available and automatically activated for all apps on Premium and Enterprise plans. Organization admins can manage AI preferences from Settings > Atlassian Intelligence in Atlassian Administration.

AI is not available in Atlassian Government organizations.

 

Use AI to effortlessly find and link related Confluence content to your work item. This allows you to have all key information at your fingertips and helps you to fully understand the work context needed to make progress.

This feature searches through your site’s Confluence, taking into account all access permissions, and presents a curated list of related content to link to the work item.

To find and link Confluence content using AI:

  1. Open a work item.

  2. Select Improve work item in the work item’s details section.

  3. Select Link Confluence content. AI finds and shows a list of Confluence links.

  4. Select Link for individual links or Link all to link all related Confluence content at once.

There may be existing work items that relate to the one you're working on, and their details can help add more context. When you link two work items together, they each appear on the other's work item view below the work item description. Linking work items doesn't change the work items in any other way.

To link a work item:

  1. Open a work item and from the quick-add buttons under the work item summary, select Add.

  2. Select Linked work item.

  3. Choose the relationship ("is blocked by" or "relates to," for example).

  4. Search for and select the work item to link.

  5. Choose Link.

To create a new linked work item, select + Create linked work item and enter the details of the new work item, including the relationship ("is blocked by" or "relates to," for example).

Once a work item is linked, it will display ion the Linked work items panel on each work item. You can also search for work items that are linked to a particular work item. More about advance searching in Jira.

Give a work item context from anywhere on the web by linking the URL. Copy and paste any link and you'll be able to see the work.

To link a web URL:

  1. Open a work item and from the quick-add buttons under the work item summary, select Add.

  2. Select Web link.

  3. Type or copy the web URL and the Link text.

  4. Choose Link.

You can do this with your keyboard via Jira’s command palette. Use command + (for Mac) or Ctrl + K (for Windows) to open the command palette while you’re in Jira.More about Jira’s command palette.

Add content from marketplace apps

If you're a Jira admin, you can find and try new Atlassian Marketplace apps right from the work item view. Select the Apps quick-add button under the work item summary and choose Add apps.

Work item content helps describe a work item in ways a description and other details can't. If your Jira site has installed Atlassian Marketplace apps, you can add content via the quick-add buttons under the work item summary. Diagrams and charts are two common types of content that can help describe a work item, but there are many other options on the Marketplace.

More about Atlassian Marketplace apps.

To the right of the Add quick-add button, you'll find the Apps button, which lists the actions you can take in any of the installed apps you have permission to use. Select Apps and then follow any required steps to add your content.

Once you select the quick-add button, you can add content from the app to your work item. This way, you can ensure everyone's seeing the latest version of a file.

Still need help?

The Atlassian Community is here for you.