Overview of IOModel documentation, product areas, and learning paths.
IOModel documentation helps teams maintain a single source of truth for architecture and specifications.
Start with Getting Started if your team is new to IOModel. It gives you the fastest path from empty workspace to a real, reviewable architecture flow.
Getting Started
Learn core concepts, setup, and your first project/spec workflow.
Product
The component map: Studio, IDE Extension, Collector, Validator, and Compiler.
Modeling
Build architecture as code with diagrams, exploration, and validation.
Specifications
Write MDX specs linked to model artifacts.
Collaboration and Review
Co-edit, diff, review, and merge changes across teams.
Recommended learning path
Create first project artifacts
Set up a project and create your first specification page.
Connect spec to model
Add objects, links, and at least one embedded model artifact.
Practice review workflow
Create branch changes, compare diffs, and merge with team feedback.
Introduce automation
Adopt AI workflows and CI validation for repeatable quality.
Use this docs set in order once, then treat it as onboarding material for new team members.
Last updated on