Skip to main content

Creating and Managing Maps

Maps are the top-level structure for documenting a feature area, workflow, or domain in UiGraph.

Each map gives your team one place to collect:

  • frames and diagrams
  • implementation context
  • drill-down navigation into related maps
  • ownership and status context for a bounded piece of the system

When to create a map​

Create a new map when you want to document:

  • a product workflow such as onboarding or checkout
  • a domain such as billing or identity
  • an internal platform capability such as deployment or observability
  • a handoff boundary between teams or systems

Avoid using one giant map for an entire product. Smaller, well-named maps are easier to maintain and easier for readers to navigate.

A strong map usually includes:

  • a clear title tied to a business capability or workflow
  • a short description that explains scope
  • a sequence of frames or diagrams that tell the story
  • point-level links to APIs, services, databases, tests, or child maps

Creating a map​

The exact UI may evolve, but the workflow stays the same:

  1. Open the maps area in UiGraph.
  2. Create a new map.
  3. Set a name and description that reflect the scope.
  4. Add frames or diagrams that support the story you want to document.
  5. Add points to connect interface regions to implementation details.

Operating a map over time​

Use maps as living documentation:

  • update frames when the product or architecture changes
  • keep point labels and downstream links current
  • archive or replace maps that no longer reflect production behavior
  • split large maps when they become hard to scan

Naming guidance​

Prefer names like:

  • Checkout Flow
  • Identity and Access
  • Support Operations Console

Avoid names like:

  • Map 1
  • Main system
  • New screens