Diagrams

Purpose

Produce technical diagrams as text, so they live in version control, appear in code review, and can be corrected when the system changes — instead of a PNG in a wiki that was accurate two years ago.

When to Use

• Documenting an architecture, a data flow, or a request path.
• Explaining a sequence of interactions between services.
• Visualizing a state machine or a decision flow.
• Adding a diagram to a README, an ADR, or a design document.

Capabilities

• Mermaid: flowcharts, sequence diagrams, state diagrams, ER diagrams, Gantt.
• Diagram-type selection.
• Layout control and readability.
• Rendering to SVG or PNG for contexts that do not support Mermaid.