Getting Started

Owned by Alex Vovchuk
Last updated: Apr 17, 2024
3 min read

 

Open the Add-on

After installing the add-on, navigate to any of your Jira projects. In the sidebar, locate the "Smart AI Release Notes" link and click it to access the add-on.

Filter Issues

To begin preparing your team updates or release notes, you'll need to select the tickets you want to include in the summary.

Click the "Get Started" button on the homepage or the "Filter Issues" button in the top right corner to open a side panel with the main configuration options for generating your summary.

To filter tickets, use the Jira Query Language (JQL) field. It supports standard JQL syntaxes. Refer to the official Atlassian documentation for guidance.

After entering your JQL query, click the "Apply Filters" button, and the filtered tickets will appear in the list below.

 

Pro tip: Issue Descriptions

Ensure that your tickets include well-written descriptions with the necessary details to create a high-quality summary. This step significantly enhances the quality of the generated summary.

Select Issues

Within the list of filtered issues, you can select or deselect individual issues by clicking on the corresponding checkbox next to each issue.

To select or deselect all issues in the list, use the "Select All" checkbox at the top of the list.

 

 

Token limit

The AI model has a limit on the amount of information it can process, set at 1500 tokens for the ticket input. To keep track of the tokens used, there is a progress bar and a counter displaying the input token count for your currently selected issues.

As a rule of thumb, one token generally corresponds to approximately 4 characters of common English text, which is roughly ¾ of a word (so 100 tokens ≈ 75 words).

 

Input Data for AI

The AI model takes the issues fields for an input to generate the summary:

  • Issue key

  • Summary

  • Description

  • Status

 

Add Context

To enhance the summary, it is recommended to provide additional context to the AI model, enabling it to better understand your context and tailor the summary. At the bottom of the side panel, you'll find a text field labeled "Additional Context" (limited to 1000 characters). Here, you can include the following information:

  • General information about the project

  • Additional context on release tickets

  • Additional instructions for the AI model

 

Generate Summary

Once you have finished configuring your inputs, click the "Generate Summary" button. The AI model will commence processing your request, which may take up to one minute. After the model has finished processing, you will see the summary of your selected tickets.

Regenerating Summary

To regenerate a summary with the same configurations, click on the "Filter Issues" button and rerun the request.

 

Results History

To access your older summary results, follow these steps:

  1. Click on the 3-dot menu in the top right corner.

  2. Select "Results History."

  3. You will open a history list with saved results.

  4. To view a summary, click on it, and you will also have the option to regenerate the summary with the same parameters.

That's it! You are now equipped to effectively use the "Smart AI Release Notes" plugin for Jira.