agentleFS
jeremymcsjeremymcs/skills/system-diagrammer/SKILL.md

system-diagrammer

Skill8 starsChanged 6 months agoMITView on GitHub

Slowly walk codebases and related project evidence to diagram data flow, workflows, dependencies, integrations, and connections between systems; record findings; verify each edge; and recommend fixes for breaks, edge cases, missing links, and disconnects. Use when the user asks to create, audit, validate, or troubleshoot architecture diagrams, workflow diagrams, integration maps, service maps, data lineage diagrams, sequence diagrams, system dependency maps, or cross-system debugging reports.

The file

Show its rules and text

We split this skill into the rules it gives an agent

21 rules. About 0 are common, 20 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈20

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill when the user needs a slow code-backed walkthrough and diagram explaining how systems, data, workflows, services, teams, …

    line 10
  2. Distinctive:

    Default stance: a diagram is a claim.

    line 12
  3. Distinctive:

    Every important node and edge has evidence, an owner/source, or is marked as an assumption.

    line 16
  4. Distinctive:

    Ask one targeted question if the boundary or expected output is unclear.

    line 26
  5. Distinctive:

    Prefer a narrow verified diagram over a broad speculative one.

    line 27
  6. Distinctive:

    Read docs, source code, configs, manifests, runbooks, env examples, CI/deploy files, API schemas, database migrations, logs, tests, …

    line 29
  7. Distinctive:

    Use repository search and file lists to avoid missing hidden paths.

    line 31
  8. Distinctive:

    Follow real entrypoints and callers before drawing shared utilities or inferred dependencies.

    line 32
  9. Distinctive:

    Keep a running findings log with file paths, line references when useful, evidence, impact, and likely fix.

    line 33
  10. Distinctive:

    If any of those are unknown, keep the edge but label the unknown explicitly.

    line 40
  11. Distinctive:

    Do not collapse multiple hops into one arrow when an intermediate system can fail or transform data.

    line 41
  12. Distinctive:

    Check edge cases: duplicate events, delayed delivery, partial failure, rollback, backfill, deletion, auth expiry, rate limits, malformed …

    line 44
  13. Distinctive:

    Use Mermaid by default because it is text-reviewable.

    line 47
  14. Distinctive:

    Do not make diagrams from memory when project evidence is available.

    line 110
  15. Distinctive:

    Do not hide unknowns inside clean arrows.

    line 111
  16. Distinctive:

    Do not treat docs, comments, or names as proof.

    line 112
  17. Distinctive:

    Do not over-diagram. If the user needs debugging, prioritize the path that can break.

    line 113
  18. Very specific:

    Do not skip code traversal silently.

    line 114
  19. Distinctive:

    Do not give vague recommendations.

    line 115
  20. Distinctive:

    Do not create vendor-biased labels or recommendations.

    line 116
  21. Distinctive:

    Do not credit any AI for generated diagrams or analysis.

    line 117

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

System Diagrammer

Use this skill when the user needs a slow code-backed walkthrough and diagram explaining how systems, data, workflows, services, teams, tools, APIs, queues, databases, jobs, or integrations connect.

Default stance: a diagram is a claim. Do not draw final edges until evidence supports them.

Success Criteria

  • Every important node and edge has evidence, an owner/source, or is marked as an assumption.
  • The diagram exposes direction, trigger, data shape, protocol, timing, storage, retries, and failure behavior where relevant.
  • Disconnects, ambiguous ownership, missing handoffs, edge cases, and breakpoints are called out explicitly.
  • Findings are recorded as the code is walked, with severity, evidence, and recommended fixes.
  • The output is useful for debugging, not just presentation.

Workflow

  1. Define scope.
    • Identify the system boundary, user/workflow being traced, start event, end state, and level of detail needed.
    • Ask one targeted question if the boundary or expected output is unclear.
    • Prefer a narrow verified diagram over a broad speculative one.
  2. Gather evidence slowly.
    • Read docs, source code, configs, manifests, runbooks, env examples, CI/deploy files, API schemas, database migrations, logs, tests, queue/job definitions, dashboards, and issue history as available.
    • For codebases, walk all relevant code deliberately: entrypoints, routes, handlers, domain services, clients/adapters, jobs, events, persistence, auth, config, tests, and deployment wiring.
    • Use repository search and file lists to avoid missing hidden paths. If a full walk is impractical, state the sampling strategy before relying on it.
    • Follow real entrypoints and callers before drawing shared utilities or inferred dependencies.
    • Keep a running findings log with file paths, line references when useful, evidence, impact, and likely fix.
    • For external systems, separate verified contracts from names mentioned in prose.
  3. Build an inventory.
    • List systems, actors, stores, interfaces, messages, jobs, events, secrets, network boundaries, and ownership.
    • Mark each item as Verified, Inferred, Assumed, Missing, or Contradicted.
  4. Connect one edge at a time.
    • For each connection, capture: source, target, trigger, direction, payload/data, protocol, auth, timing, retry/idempotency behavior, failure path, and evidence.
    • If any of those are unknown, keep the edge but label the unknown explicitly.
    • Do not collapse multiple hops into one arrow when an intermediate system can fail or transform data.
  5. Debug the map.
    • Hunt for breaks: missing producers/consumers, one-way writes with no reader, read paths with no writer, unhandled retries, circular dependencies, manual handoffs, stale docs, orphaned config, unowned data, schema drift, hidden cron jobs, race conditions, and missing observability.
    • Check edge cases: duplicate events, delayed delivery, partial failure, rollback, backfill, deletion, auth expiry, rate limits, malformed payloads, empty state, replay, and out-of-order processing.
    • Where possible, run targeted commands/tests or inspect runtime evidence to verify disputed edges.
  6. Produce diagrams.
    • Use Mermaid by default because it is text-reviewable.
    • Pick the smallest diagram type that fits:
      • flowchart for system/data movement and dependencies.
      • sequenceDiagram for request/event timing.
      • stateDiagram-v2 for lifecycle and status transitions.
      • erDiagram for data ownership and relationships.
    • Split large maps into context, detailed workflow, and failure-path diagrams instead of making one unreadable diagram.
  7. Report verification.
    • Include an evidence table and an uncertainty list.
    • Lead with disconnects and breakpoints when the task is diagnostic.
    • Provide concrete fix recommendations for each meaningful finding, ordered by impact and dependency.
    • State what was not verified and why.

Output Format

## System Diagram

Scope: boundary, start event, end state
Confidence: High | Medium | Low

```mermaid
flowchart LR
  A[System A] -->|verified action/data| B[System B]
```

### Evidence

| Connection | Status | Evidence | Notes |
| --- | --- | --- | --- |
| A -> B | Verified/Inferred/Assumed/Missing/Contradicted | File, command, log, doc, or observation | Trigger, payload, failure behavior |

### Breaks and Edge Cases

1. Issue or risk
   - Evidence:
   - Impact:
   - Debug/verification step:
   - Recommended fix:

### Findings

| Severity | Finding | Evidence | Recommendation |
| --- | --- | --- | --- |
| High/Medium/Low | What is broken, risky, or unclear | File, command, log, doc, or observation | Specific fix or next verification step |

### Open Questions

- Question blocking higher confidence.

### Verification Performed

```bash
commands or checks run
```

### Limits

- Anything not inspected, unavailable, or still assumed.

Guardrails

  • Do not make diagrams from memory when project evidence is available.
  • Do not hide unknowns inside clean arrows.
  • Do not treat docs, comments, or names as proof; verify against code, config, runtime, or contracts when possible.
  • Do not over-diagram. If the user needs debugging, prioritize the path that can break.
  • Do not skip code traversal silently. If a file area, integration, or runtime path was not walked, list it in Limits.
  • Do not give vague recommendations. Tie each recommendation to a finding and evidence.
  • Do not create vendor-biased labels or recommendations. Use neutral system names and technical evidence.
  • Do not credit any AI for generated diagrams or analysis.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.