We’re pleased to announce a series of updates to our AI-generated issue data that we hope will enhance the content’s value and make the tool accessible to even more audiences.
Problem, Cause, Impact
Every AI-generated issue explanation includes three elements: a description of the problem, an explanation of the issue’s cause, and an impact statement. Until now, these three components have been jumbled together in 1-2 chunky paragraphs. While the information is valuable, its presentation affects readability and doesn’t always accommodate the user who wants to scan an issue quickly to determine its priority.
To make the issue explanations more digestible at a glance, we’ve separated the information between three headings: Problem, Cause, and Impact. Each section includes a short, focussed paragraph that a technical or non-technical user can read at a glance.
[js-issue-explanation]
Additionally, we’ve removed the Generate Explanation button. From now on, issue explanations will generate automatically as soon as you open a new issue.
Split AI Components
Until now, all AI-generated content has existed within a single component on the Technical Details tab. One of our major goals this year has been to improve usability and make information accessible and relevant to as many users as possible, and part of that initiative involves separating high-level issue data from deeper, technical information. To that end, we’ve decoupled Issue Explanations from the Potential Solution, and split the AI content between multiple tabs.
From now on, the human-readable Issue Explanations will live at the top of the Overview tab beneath the issue’s number and title.
[issue-overview]
The Potential Solution, including the code fix snippet, will remain on the Technical Details tab above the Stacktrace and other developer-focussed tools.
[developer-overview]