agentleFS
mikeparcewskimikeparcewski/wicked-garden/skills/engineering/system-design/SKILL.md

wicked-garden-engineering-system-design

Skill9 starsChanged 7 months agoMITView on GitHub

Use when decomposing a system into components with clear boundaries, module organization, and interface contracts — the "how do we slice this?" question at design time. NOT for reviewing an existing system's health (use the architecture skill or engineering:arch).

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 3 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Acyclic: - No circular dependencies

    line 76
  2. Distinctive:

    Keep It Simple: - Don't over-decompose

    line 127
  3. Distinctive:

    Test Boundaries: - Use contract tests

    line 128

≈ “Common” is an estimate: at least 1 in 5 of the 372,429 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 Design Skill

Decompose systems into well-defined components with clear boundaries and interfaces.

Purpose

Transform architecture into concrete components:

  • Component identification and boundaries
  • Interface definition
  • Dependency management
  • Module organization

Process

1. Identify Components

Ask:

  • What are major capabilities?
  • What changes together?
  • What has different scaling needs?
  • What domain concepts exist?

2. Define Boundaries

Apply:

  • High Cohesion - Related functionality together
  • Low Coupling - Minimal dependencies
  • Single Responsibility - One reason to change
  • Information Hiding - Encapsulate internals

3. Design Interfaces

For each component:

  • Public API (what it exposes)
  • Dependencies (what it needs)
  • Events (what it publishes/subscribes)
  • Data contracts (I/O structures)

4. Document

Creates in phases/design/:

design/
├── components/
│   ├── overview.md
│   ├── auth-component.md
│   └── dependencies.mmd
└── interfaces/
    └── component-api.md

Component Patterns

Layered - Presentation → Application → Domain → Infrastructure Hexagonal - Business logic with adapter ports Plugin - Core system with pluggable extensions

See component patterns in refs/ (patterns-layered-pattern.md, patterns-facade-pattern.md).

Dependency Management

Rules

  1. Acyclic - No circular dependencies
  2. Unidirectional - Dependencies flow one way
  3. Stable - Depend on stable abstractions
  4. Explicit - Declare in constructor/config

Common Anti-Patterns

God Object - One component does everything Fix: Split by responsibility

Feature Envy - Component uses another's data extensively Fix: Move functionality to data owner

Circular Dependencies - A depends on B, B depends on A Fix: Extract shared logic or use events

Leaky Abstraction - Internal details exposed Fix: Refine public interface

See dependency guides in refs/ (dependencies-dependency-principles.md, dependencies-best-practices.md).

Integration

With Architecture Skill

Implements high-level architecture:

  • Takes architectural decisions
  • Maps to concrete components
  • Validates feasibility

With Integration Skill

Provides boundaries for:

  • API design
  • Service contracts
  • Event schemas

With wicked-crew

Called during design phase after architecture.

Events

  • [arch:components:defined:success] - Components designed
  • [arch:interface:defined:success] - Interface documented
  • [arch:dependency:analyzed:success] - Dependencies validated

Tips

  1. Start with Boundaries - Define what's in/out first
  2. Think in Interfaces - Design API before implementation
  3. Keep It Simple - Don't over-decompose
  4. Test Boundaries - Use contract tests
  5. Refactor Gradually - Small, safe steps
  6. Document Dependencies - Make them explicit

Reference Materials

  • Component Template:
    • Structure & API
    • Lifecycle & Deployment
    • Maintenance & Examples
  • Interface Template:
    • Structure & Contracts
    • Testing & Operations
    • Examples & Tips
  • Component Patterns:
    • Layered
    • Plugin Architecture
    • Facade
    • Dependency Injection
  • Dependencies:
    • Principles
    • Tracking
    • Best Practices
  • Anti-Patterns:
    • God Object
    • Big Ball of Mud
    • Circular Dependencies
    • Feature Envy

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.