diagram-as-code

Topics in the source

• Diagram as Code
• Quick Start
• When to Use
• Best Practices
• Picking the Type
• Readability
• Correctness
• Rendering

Workflows, architecture and business processes as validated code, not pixels. System architecture and service maps Business processes and approval flows Sequence diagrams for APIs and auth State machines, ER diagrams, C4 models Docs that must stay in sync with code Flowchart: decisions and processes, max 12 nodes per view Sequence: interactions over time, name every actor Class/ER: data models, no methods except key behavior State: explicit initial/final, every transition labeled C4: Context for stakeholders, Container for teams, Component for devs One idea per diagram, split large flows into subgraphs Left-to-right for processes, top-to-bottom for hierarchies Short node labels (3-5 words), details in notes Stable ids in latin, human labels separate Every branch has a condition label No orphan nodes, no crossing arrows without need Actors and services match the real codebase names Version the diagram next to the code it describes Prefer Mermaid for Markdown-native docs C4-PlantUML for enterprise architecture SVG output for docs site, dark + light tested Keep source .mmd in git, render on CI 1. State the single question the diagram answers. 2. Pick the minimal type (flowchart, seque

This is an excerpt. Refer to the complete source and its current requirements.