Shape Notes
Add documentation directly to diagram shapes with simple text notes or rich notes with links to pages, diagrams, and graph diagrams.
Shape Notes allow you to attach documentation directly to individual shapes in your diagrams. Each shape can have its own note containing text and links to related content elsewhere in your documentation.
When to Use Shape Notes
Shape notes are useful for:
Contextual Documentation
Explain what a component does without cluttering the diagram.
Cross-References
Link a shape to its detailed documentation page, related diagrams, or data models.
Review Comments
Add notes during architecture reviews.
Implementation Details
Document technical considerations for developers.
Adding a Note
Simple vs Rich Notes
Notes come in two modes:
| Mode | Description | Best For |
|---|---|---|
| Simple Notes | Plain text, ideal for quick comments. The popover lets you type and save immediately. | Quick annotations and reminders |
| Rich Notes | HTML formatting and links to other documents. Click the expand icon to switch to rich mode. | Detailed documentation and cross-references |
Rich Note Features
Rich notes open in a side panel with multiple types of content:
Adding Links
Use Cases
Visual Indicators
Shapes with notes show a small grey dot in their bottom-right corner. This indicator:
| Behaviour | Description |
|---|---|
| Visibility | Appears on any shape with a note (simple or rich) |
| Interaction | Is clickable to open the note directly |
| Export | Does not appear in exported images or published diagrams |
Editing and Removing Notes
To edit an existing note, right-click the shape and click the sticky note icon, or click the indicator dot directly.
To remove a note: