Skip to main content

Architecture Overview

The Architecture Overview is a built-in skill that tells Autoheal how your production system fits together. It should be short, current, and opinionated enough that an on-call engineer could read it before debugging an unfamiliar service.

Autoheal reads this skill during investigations, so use it for context that applies across many incidents rather than one-off remediation steps.

What To Include​

  • Core services, ownership, and the customer-facing capabilities they support
  • Important dependencies, queues, databases, caches, and third-party APIs
  • Environment names, regions, deployment topology, and how to identify them in logs or alerts
  • Critical request flows, background jobs, and asynchronous handoffs
  • Operational gotchas your team already knows to check during incidents

Keep It Useful​

Update the overview when architecture, ownership, deployment shape, or investigation assumptions change. For incident-specific steps, create a separate custom skill or runbook so the Architecture Overview stays easy to scan.