Skip to main content

Adding documentation

How to add documentation to your diagram​

EventCatalog Studio allows you to add documentation to your diagram.

Some use cases include:

  • Capturing context of your diagram
  • Architecture decision records
  • Runbooks
  • Team processes
  • Onboarding information

To add documentation to a design, click on the Documentation button in the sidebar.

Edit node

This will open a sidebar with the documentation editor.

Writing content in the documentation editor will attach that content to the diagram.

How to reference nodes in your documentation​

You can help your teams and users understand your design by adding documentation to your diagram.

You can reference any node in your documentation using the @ syntax in the editor.

This will let you choose the node you want to reference.

Reference node

Reference nodes in your documentation

Adding references to nodes in your documentation will help your teams and users understand your design. You can use them to walk through your design, or to explain how it works.

When you export your design, the references will be included in the exported documentation.