iyedy docs, home
FR Lire en françaisOpen iyedy (opens in a new tab)

Your first diagram in 10 minutes

Build the containers view of a small claims platform, check it, ask the Assistant for one change, then save a version you can share.

Tutorial · 6 steps · 10 minFree planA few credits in steps 2 and 5, shown before you sendOpen iyedy (opens in a new tab)

Create a diagram (free, no AI)

A diagram holds one model of your system and the views drawn from it. Start with an empty one.

  1. Open iyedy

    Go to app.iyedy.com and sign in. You land on your Home page.

  2. Create the diagram

    Press Ctrl K, type library and run Open library. In the Library, select New diagram: iyedy creates Untitled diagram and opens it in the editor.

  3. Name it

    Double-click the diagram's name in the bar above the canvas, or press F2. Type Claims Platform and press Enter.

Check your work. The editor opens on Claims Platform, and the diagram is listed in My diagrams.
On Free

You can keep 5 active diagrams. This tutorial uses one.

Add the system, then its containers (a few credits, shown before you send)

The new diagram is empty: the sheet says The model is empty, and every view needs a system first. A container is something that runs inside that system: an app, a service, a database. Describe them in one sentence and let the Assistant draft them.

  1. Describe the system

    Press Ctrl J to open the Assistant, and write: “A software system called Claims Platform, with three containers: Mobile app (React Native), API gateway (API Management) and Claims Service (.NET 8). The Claims Service calls an external system called Payments.”

  2. Apply the draft

    The draft shows on the sheet before anything changes. Read it, then select Apply.

  3. Open the Containers view

    In the Views list on the left, select the Containers view.

Check your work. Mobile app, API gateway and Claims Service stand inside Claims Platform, each with its technology, and Payments stands outside it.

Connect the containers (free, no AI)

A relationship says who calls whom. Draw the two that are missing, then say what kind each one is.

  1. Pick the Relationship tool

    On the left of the canvas, select Relationship, or press R.

  2. Drag from Mobile app to API gateway

    Start on the edge of the first element and release on the second. iyedy routes the line at right angles for you.

    In the app · editor, Containers view

    The editor with the Relationship tool selected and a new relationship from Mobile app to API gateway, open in the Inspector.

    1. The Relationship tool is pressed.
    2. The new relationship, selected, from Mobile app to API gateway.
    3. In the Inspector, choose its kind, for example Sync request, or press 1 to 4.
  3. Add the other relationship

    Draw API gateway → Claims Service the same way, and give it the kind Sync request. The Assistant already drew Claims Service → Payments: select it and set its kind too.

    Check your work. Three lines join the four elements, each with an arrow, and the Inspector shows the kind of the one you select.
Every view shares one model

One model, many views. Rename something here and it changes everywhere.

Run the checks (free, no AI)

iyedy's checks are rules, not AI: they cost nothing and send nothing.

  1. Run the checks

    Select Run the checks. The findings appear with their severity: HIGH, MED, LOW or INFO.

  2. Read one finding

    Select a finding to see the element it is about and why the rule flags it. You decide what to do with it.

Check your work. You see the list of findings, or none, for the Claims Platform.

Ask the Assistant for a change (a few credits, shown before you send)

The Assistant proposes, you decide. Nothing changes before you apply.

  1. Open the Assistant

    Press Ctrl J. Ask, in your words: “Add a database for the claims, used by the Claims Service.”

  2. Read the estimate

    Before you send, the Assistant shows about how many credits the request takes and how many you have left. On Free, the welcome credits pay for it.

  3. Review, then apply

    The proposal shows on the sheet as a ghost. Read it, then select Apply, or leave it.

Check your work. The new database stands on the sheet, joined to the Claims Service. Applying it saved a version.

Save a version and share it (free, no AI)

A named version is a state you can come back to and show.

  1. Save a named version

    Press Ctrl S or select Save named version…, and name it First draft.

  2. Share it

    Select Share…, enter a colleague's e-mail address and keep Can view.

Check your work. The version is in the history of the diagram, and your colleague receives an invitation to view it.

What you learned

  • A diagram is one model; each view shows part of it.
  • The checks are rules without AI; the Assistant proposes and you apply.
  • A named version is what you share and come back to.

Next

Was this tutorial helpful?Your answer is anonymous and counts only if you accepted measurement.

What went wrong?

Don't write personal data.

Navigation

iyedy docs, home
Lire en françaisOpen iyedy

↑ ↓ moveEnter openCtrl Enter new tabSearching English docs ·