Logo
NeoArc Studio

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:

Content Foundry
Create publishable documentation as websites or PDFs
Architecture Views
Visualise different aspects of enterprise architecture
Domain & Business Architecture
Model business domains and processes
Data Architecture
Model data assets and flows
Application & Integration Architecture
Document APIs, schemas, and integrations
Cloud & Infrastructure Architecture
Model cloud and infrastructure
Operating Model & Strategy
Document operating models and strategic initiatives
Governance
Manage architecture decision records and policies

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?

Learn the Core Concepts
Understand workspaces, architecture directories, Content Foundry publications, site bindings, and publishing targets. These concepts will help you structure your documentation effectively.
Try the Specialised Content Blocks
NeoArc has a wide range of content block types designed for architecture documentation. Explore assumptions, constraints, principles, NFRs, risks, and trade-off matrices.
Publish Your Documentation
When you're ready to share, NeoArc can publish your Content Foundry publications as static websites or PDFs. Export to a local folder, publish to Azure, or generate a professional PDF document.

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
Key Concepts

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.

Creating Your First Diagram

Learn the basics of creating diagrams in NeoArc Studio. Add shapes, connect them, and arrange your diagram for clarity.