User Documentation

Welcome to Korgraph 🎯

Korgraph is an interactive web-based tool for modeling enterprise architectures. Model your business domains, technical systems, and workflows in one integrated environment.

🚀 Quick Start Navigation

graph LR Start[👋 New to Korgraph?] --> Learn[📚 Learn the Basics] Start --> Try[🎨 Try Key Features] Start --> Reference[📖 Reference Docs] Learn --> Perspectives[🔍 3 Perspectives
Components • Systems • Processes] Learn --> Concepts[💡 Core Concepts
Domains • Contexts • Workflows] Try --> Story[📝 Story Editor
Write process narratives] Try --> Draft[✏️ Draft Workflow
Safe experimentation] Try --> Import[📦 YAML Import/Export
Version control] Reference --> Elements[🧩 Element Types
17 building blocks] Reference --> Categories[🗂️ Category Guides
Conceptual overviews] click Perspectives "user/README.md#-perspectives" click Story "user/STORY_EDITOR.md" click Draft "user/DRAFT_WORKFLOW_GUIDE.md" click Import "user/YAML_IMPORT_EXPORT.md" click Elements "#-element-reference" click Categories "#-understand-the-concepts" style Start fill:#e1f5ff,stroke:#0066cc,stroke-width:3px style Learn fill:#fff4e1,stroke:#cc8800 style Try fill:#e1ffe1,stroke:#00aa00 style Reference fill:#ffe1f5,stroke:#cc0066

📚 Learn: Understand Korgraph

🔍 The 3 Perspectives

Korgraph organizes your architecture into three interconnected views:

Perspective Purpose Key Elements
Components Model your business domains Domain → Subdomain → Context
Systems Map your technical landscape System → Module → Feature
Processes Document business workflows Process Landscape → Process

💡 Core Concepts

What makes Korgraph different?

🎨 Try: Key Features

📝 Story Editor

Create process flows by writing simple sentences:

Customer submits Order to Order Management
Order Management validates Payment with Payment Service
Payment Service publishes OrderPaid event

→ Automatically generates visual process diagrams! See examples

✏️ Draft Workflow

Experiment safely without affecting production:

  1. Create a draft for isolated changes
  2. Review and test your modifications
  3. Merge with conflict resolution
  4. Approve and publish

📦 YAML Import/Export

Version control your architecture:

  • Export entire architecture or specific contexts
  • Store in Git for history tracking
  • Import on startup for automated deployment

🌍 Physical World Modeling

Model beyond digital systems:

  • Physical objects (documents, products, equipment)
  • System-independent process steps
  • Real-world actor interactions

📖 Reference: Documentation

🧩 Element Reference

Organizational Elements (Define business structure)
  • Company - Root organization
  • Domain - Business capability area (e.g., Sales, Logistics)
  • Subdomain - Specific business area (Core, Supporting, Generic)
  • Context - Bounded context in DDD
  • Actor - Person, team, or external system role
Technical Elements (Implement functionality)
Process Elements (Orchestrate workflows)
Scope Elements (Track deployment)

🗂️ Understand the Concepts

Deep dives into how Korgraph organizes your architecture:

💬 Get Help & Share Feedback

  • View Feature Requests & Bug Reports - See what's being worked on
  • Submit Feedback - Use the Feedback button in the app
  • Interactive Tour - Click "Help" in the footer for a guided walkthrough

🎯 Common Tasks

I want to... Go here
Understand the 3 perspectives Perspectives Overview
Create my first process story Story Editor Guide
Learn about a specific element type Element Reference
Use draft workflow Draft Workflow Guide
Export my architecture to Git YAML Import/Export
Model physical objects Physical World Modeling
See example process stories Story Examples
Quick reference for story syntax Story Quick Reference

Ready to start? Open Korgraph and choose a perspective: Components, Systems, or Processes!