Skip to main content

Add diagrams to a Jira work item

Add the Mermaid Diagrams panel to a work item to keep one or more diagrams on it. Jira doesn't show the panel until someone adds it.

Before you begin​

  • Mermaid Diagrams for Jira is installed on your site.
  • You have the Edit work items permission in the space.
  • Your Mermaid Diagrams license is active. Viewing diagrams doesn't need one.

Add the panel​

  1. Open the work item.

  2. Under the summary, select View app actions (the apps icon) > Mermaid Diagrams.

    The View app actions menu under a work item's summary, with Mermaid Diagrams highlighted

    The Mermaid Diagrams panel is added under the description, and the diagram editor opens.

  3. Start the diagram from a snippet, an import, Draft with AI, or your own code. See Edit a diagram.

  4. Select Save and close.

Result: The diagram shows in the panel for everyone who can see the work item.

The Mermaid Diagrams panel on a work item showing a swimlane process

Show, collapse or remove the panel​

Open the panel's ••• menu:

  • Show for all work items shows the panel on every work item, so nobody has to add it.
  • Collapse folds the panel away on this work item.
  • Remove takes the panel off this work item. The diagrams aren't deleted: add the panel again to see them.

The panel's menu with Show for all work items, Collapse and Remove

Change a diagram later​

  1. Hover over the diagram in the panel and select Edit diagram (the pencil icon).
  2. Make your changes and select Save and close.

Diagrams in the panel are kept in the app's storage. They don't appear in the work item's attachments or history.

When the description or comments hold Mermaid code blocks, the panel also lists them under Found in this work item. See Edit Mermaid code blocks in Jira.