Getting Started
Get up and running with NeoArc Studio in five minutes. Download the app, create a workspace, define your data model, create views, and build your first architecture documentation.
This guide walks you through installing NeoArc Studio and creating your first piece of content. By the end, you'll have a working workspace with either an architecture diagram or a documentation page ready to commit to Git.
Installation and Setup
Architecture Directories
NeoArc organises content into eight architecture directories:
Create Your First Content
You have several options depending on what you want to document:
Model-First Workflow
For data-driven projects, NeoArc supports a model-first approach where you define your data model before creating diagrams or documentation. This way, every artefact traces back to a single source of truth.
Save and Commit
NeoArc automatically saves your work to the workspace folder as JSON files. To version control your documentation:
git add .
git commit -m "Add initial architecture documentation"What's Next?
Need Help?
If you get stuck:
- Check the Key Concepts guide for explanations of NeoArc terminology
- Browse the Guides section for task-specific tutorials
- Look at the Reference documentation for detailed specifications
Understand the core concepts in NeoArc Studio: workspaces, architecture directories, data model, views, database profiles, search profiles, property projections, Content Foundry publications, site bindings, diagrams, and publishing targets.
Learn the basics of creating diagrams in NeoArc Studio. Add shapes, connect them, and arrange your diagram for clarity.