Miro + Confluence for better product documentation

Miro and Confluence can work wonders alone, and now their combination is even more powerful than it used to be. Let me tell you about this cool new integration and how to get started!

What are Miro and Confluence?

Confluence is made by the great people at Atlassian, who also make Jira. Product and Project teams use Confluence to process and consult documentation. If this is completely new to you, think of a wiki with all the information about a given product.

Miro, previously known as RealTimeBoard, is my go to tool for diagraming and post-it format collaboration. You may remember this from my post about the tools I use as a remote worker. I use Miró to create my conversational workflows, to brainstorm and to explain concepts like pipelines and funnels.

Why use Miro in Documentation?

Some people understand documentation as set on stone affirmations. They believe these must be redacted in a lengthy and technical fashion. That they must be reviewed in long meetings and signed-off by all stakeholders. I disagree. I believe any documentation, even if just a quick Google Doc, is a great way to start. It helps bring the knowns and the unknown out of our brains and in a common place.

I believe product documentation, in an agile world, is this artifact we can use to refine our conventions and principles. To store knowledge and tips. To onboard team members and inform press releases or investment rounds. A great way to work on this kind of documentation is diagraming and working with post its.

Post-its can be moved around, and allow for a very flexible information architecture. They can adapt to incorporate feedback, and the different sizes and colors allow for a compact density if information. This is why they are so popular in workshops, why we use them to remember things and why tools like Miro are so popular.

Smiling young woman brainstorming using adhesive notes on glass wall by Jacob Lund from Noun Project

What’s this new integration?

Using both tools worked, but now the integration is even better. Confluence and Miro have recently launched an integration that makes it possible to embed whiteboards in Confluence pages.

Instead of downloading images or adding links, display your whiteboard. This allows for contextual visualization of your flows and exercises and for easy access to collaboration.

  1. Copy a Miro Link and paste it in the Confluence page
  2. Click on the link to integrate and follow the steps
  3. You will see a dropdown with the display options

You can choose one of four options:

  • Insert a full URL
  • Display as inserted, the usual Miro icon and Whiteboard title badge in Jira
  • Insert a card view, with a thumbnail of the preview section of the board
  • Enter as an object.

This last view, the Miro whiteboard shared as an editable object, opens the door to better than ever documentation. Integrations like Google Sheets and Figma were already possible. While they had greatly improved Confluence, I believe this new feature changes the game.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: