Descriptions

Adding descriptions to technical diagrams is essential for clarity, accessibility, and understanding. They explain components and relationships, helping viewers grasp complex systems, and provide important context that diagrams alone lack. Descriptions also reduce ambiguity and enhance the quality of documentation by integrating visuals with text. Additionally, they support collaboration by ensuring a shared understanding among stakeholders, making diagrams more effective tools for communication and learning.

Read more about architecture diagramming best practices in our guide.

See how they are used on our examples page.

Components

Description - Inline

Description - Inline provides concise descriptive text directly within the main content, used for quickly clarifying or explaining a concept.

Step Description - Footer Box

Step Description - Footer Box is a highlighted description that appears in a footer layout block, typically used to summarize or provide additional details for a step or process.

Use to provide an "at a glance " view of key responsibilities.

Step Description Callout

Step Description Callout is a prominently styled description used to draw attention to important details or instructions related to a step or procedure.