Go from a blank workspace to a real, connected architecture flow: understand the product, learn the core concepts, and ship your first project, spec, and model change.
IOModel keeps your architecture model, diagrams, and specifications in one place — and checks that they stay consistent with each other and with the system you actually run. Getting Started is the shortest route from a blank workspace to a working team flow.
Onboarding a team? Run this section end-to-end once, then keep it as your repeatable onboarding checklist.
Start here
Understand the product and vocabulary
Read Overview & Concepts to learn what IOModel is made of (Studio, IDE Extension, Collector, Validator, Compiler) and the core terms — model, specification, artifact, branch — used across every workflow.
Create your first project
Follow First Project to set up the shared workspace that holds your model and specs.
Write your first spec
In First Spec, capture one real decision and embed a live model artifact so the spec stays linked to the architecture.
Make your first model change
Use First Model Change to edit the architecture model from the Explore canvas and see it reflected in your spec.
What you will achieve
Concepts aligned
A shared vocabulary for model, specification, artifact, branch, and review.
A real project
A project with a stable key that anchors every URL and artifact.
A linked spec
A specification page that embeds a live model artifact instead of static text.
A model change
Your first edit to the architecture model, made from the Explore canvas.
Section map
Overview & Concepts
What the product is made of, how Studio and the IDE complement each other, and the core terms.
Quickstart
Hands-on: first project, first spec, and first model change in about 10 minutes.
Product
Drill into a specific tool: Studio, IDE Extension, Collector, Validator, or Compiler.
Before you start
- An account with access to an organization (or a local workspace).
- Editor permission or higher on the organization/project — otherwise creation buttons are hidden.
- About 10 minutes for the Quickstart.
If a button described in these pages is missing, you most likely have viewer access. Ask an org or project admin to grant you the editor role.
Last updated on