← Back to Documentation Home

User Documentation

System Module

A System Module represents a component or subsystem within a larger system.

Key Fields

  • Name: Module identifier
  • Description: Purpose and responsibilities

How It Works

graph LR System[System] -->|contains| Module[System Modules] Module -->|contains| Feature[Features]

Modules provide internal structure to systems:

  • Order System → Checkout Module, Inventory Module, Shipping Module
  • CRM System → Contact Module, Lead Module, Opportunity Module

Organizing Features

Features are grouped under modules:

  • Helps visualize system architecture
  • Shows clear separation of concerns
  • Makes large systems more understandable

Integration

  • Storage: korgraph database, type systemmodule
  • Hierarchy: Child of system, parent of feature

Tips

  • Use functional groupings (not technical layers)
  • Each module should have a clear purpose
  • Keep modules at similar levels of abstraction
  • Document responsibilities in description