SKILL.md
Sequence Diagram Skill
When the question is "in what order do these things talk to each other?", a sequence diagram is the clearest answer. This skill turns a described interaction — an API call chain, an auth handshake, a webhook flow — into a correct Mermaid sequence diagram with participants, ordered messages, return values, and the important error/timeout paths.
Required Inputs
Ask for these only if they aren't already provided:
- The participants — the actors/services/systems involved (client, API, DB, third party…).
- The messages — what each one sends to the next, in order; what comes back.
- Sync vs async — which calls block on a response vs fire-and-forget.
- Edge cases — the failure, timeout, or alternative path worth showing.
Output Format
[Interaction name] — sequence
One line on what flow this traces.
sequenceDiagram
actor U as User
participant W as Web app
participant A as API
participant D as Database
U->>W: Click "Sign in"
W->>A: POST /login
A->>D: Lookup user
D-->>A: User record
A-->>W: 200 + token
W-->>U: Logged in
Note over A,D: On miss, return 401
Notes — failure/timeout handling, retries, idempotency, anything async (-) ).
Mermaid Rules (so it renders)
- Start with
sequenceDiagram. Declare participant X as Label (or actor) up front.
- Solid arrow
->> = call/request; dashed -->> = response/return; -) = async message.
- Use
Note over A,B: ... for context and alt/else/end for alternative paths if needed.
- Keep message text short; no colons that aren't the message separator.
Quality Checks
Anti-Patterns
Based On
UML sequence diagramming (lifelines, sync/async messages, alt fragments), expressed as renderable Mermaid.