Skip to content

About

A vendor-neutral Agent Skill for designing, reviewing, and evolving production-ready software systems through clear requirements, trade-offs, reliability, security, scalability, and rollout planning.

Resources

Contributing

Security policy

Stars

4 stars

Watchers

0 watching

Forks

Repository files navigation

System Design Compass

Architecture decisions that survive the failure path.

A precision compass on a navy architectural map, with a copper route connecting the chosen system boundaries.

Agent Skills Status License: MIT

Give your coding agent a better way to reason about system design, architecture reviews and safe migrations. Start with the decision, find the invariant, challenge the failure path, and collect the evidence that separates credible options.

Small entrypoint. Guidance on demand. No runtime dependencies.

Get started · See the decision lens · Browse the guides · Read the evidence

Version 1.1.0 · evaluation incomplete

The recorded behavior gate did not pass. See the report before relying on these recommendations in production.

A better question changes the design

Architecture advice becomes useful when it explains where a guarantee is enforced and what would disprove it.

Familiar advice The decision worth resolving
“Add idempotency.” What identifies the operation, where are effect and result committed, and what happens after a crash?
“Use a queue.” Does completion capacity exceed retry-amplified demand after worker loss, and who acts when age rises?
“Roll back the deployment.” Can old code still read new data, and which external effects are irreversible?
“Shard for scale.” Which measured bottleneck requires it, and does the key distribute real traffic?
“Modernize the architecture.” What is actually broken—and which sound decisions should remain?

Three useful reminders to take into a design review:

A timeout is an unknown outcome.

Queue storage is not recovery capacity.

Restoring old binaries does not undo incompatible writes.

These are prompts for investigation, not substitutes for evidence.

Get started

Install from the repository with the skills CLI:

npx skills add Woffluon/system-design-compass

From a local checkout, run this at the repository root:

npx skills add .

Invoke the skill explicitly when your agent supports named skills:

$system-design-compass Review this service's retry and timeout boundaries.
Use repository evidence. Preserve sound decisions. Give the smallest
correction and one experiment that could falsify the recommendation.
Global installation and selected agents

Install globally:

npx skills add Woffluon/system-design-compass --global

Select agents without an interactive prompt:

npx skills add Woffluon/system-design-compass \
  --skill system-design-compass \
  --agent claude-code codex cursor gemini-cli github-copilot opencode \
  --global --yes

The CLI handles each agent's installation path. Available tools and automatic skill selection depend on the harness.

Bring a decision, not a technology shopping list

Work Example request Useful result
Design “Design delivery semantics for customer webhook endpoints.” Ownership, contracts, credible options and explicit failure guarantees.
Review “Assess this architecture's tail-latency and retry risks.” Evidence, trigger, impact, smallest correction and validation.
Evolve “Move this database while writers and old clients remain active.” Phase authority, convergence evidence and rollback boundaries.
Decide narrowly “Write an ADR for asynchronous thumbnail rendering.” One scoped decision; no mandatory full RFC.
Practice “Run a 45-minute system design interview for autocomplete.” Focused reasoning, deep dives and concrete feedback.

Supply the artifacts you have: code, schemas, configuration, SLOs, incident records or existing ADRs. Unknowns should remain visible. The response follows your language; the maintained guidance is English.

Natural-language requests can activate the skill in harnesses that discover skills automatically. Automatic activation has not been established by the current evaluation.

Find the right guide

The entrypoint routes by the decision at hand. A narrow question can be answered directly; broader work loads the relevant mode, then only the references needed to resolve it.

Decision area Read when
Design · Review · Evolution The task needs a broader workflow.
Requirements and estimation SLOs, demand, units or capacity change the choice.
Interfaces and data Ownership, identity, contracts or consistency need definition.
Distributed systems Queues, leases, replication, placement or overload affect guarantees.
Production readiness Recovery, security, observability, cost or launch evidence matters.
Decision validation A plausible mechanism lacks a falsifiable experiment or owned repair.
Deliverables and diagrams The requested audience needs an ADR, RFC, phase plan or diagram.
Interview Interview practice is explicitly requested.

28 workload topics, organized into four selective catalogs:

Catalog Examples
Foundations and platform Scaling, estimation, rate limiting, hashing, key-value stores, IDs.
User-facing and realtime Feeds, chat, autocomplete, video, file sync, maps, proximity.
Data and infrastructure Queues, metrics, aggregation, email, object storage.
Transactional and financial Reservations, leaderboards, payments, wallets, matching.

Catalogs expose questions and failure cases; they are not prebuilt architectures or a prescribed vendor stack.

Measured results and current limits

The evaluation report separates behavior, context cost and packaging. 1.1.0 is the only distributable version; rc.* labels in evaluation history identify frozen test snapshots. The full behavior gate did not pass, and the latest early check found further failures.

Observation What the evidence supports
594 → 469 entrypoint words The current entrypoint is 21.0% smaller. The approximate 400-word target remains unmet.
rc.9: 1,248 → 1,105 narrow-task read words Gemini 3.6 Flash Medium loaded 11.5% less skill text in the paired ADR case.
rc.9: 2,723 → 789 narrow-task read words Gemini 3.8 Flash Medium loaded 71.0% less skill text in the paired ADR case.
rc.9: 79 installation targets / 55 directories Installation preserves entrypoint semantics and all 14 reference files; it does not establish behavioral quality in every agent.
rc.10 early webhook: 0/2 candidate cases passed Both selected models missed required crash-window, retry-capacity or test details; the full comparison was stopped.

Read-word measurements are approximate context proxies, not token savings or universal results. Both evaluated models are user-selected Flash versions at medium effort. Earlier Codex cohorts remain separate. Failures, interrupted calls, budget amendments and grading limitations are retained in the report.

The initial September report is historical evidence for its frozen source, not a certification of this candidate.

Portable by construction

The distributed folder follows the Agent Skills specification: Markdown references and optional agent UI metadata, with no runtime scripts, MCP requirements, credentials or network dependency. Standards-compatible harnesses can load it; tools and permission enforcement remain the harness's responsibility.

Repository evaluation utilities are development tooling, not part of the skill's runtime. The cover image is also outside the distributable folder.

Contribute a failure worth catching

A useful contribution starts with an anonymized prompt, raw evidence, a consequential failure and a verifiable outcome. If this helps surface a problem before production, share the decision and the smallest reproducible case.

Read Contributing for content rules and checks, Security for private reporting, or the evaluation protocol to reproduce a comparison. The original behavioral cases describe the release expectations.

Development checks
python tools/validate_repo.py
python -m unittest discover -s tools -p 'test_*.py'
python -m pip install skills-ref==0.1.1
agentskills validate skills/system-design-compass
npx skills@1.5.26 add . --list

The specification validator is a development dependency. These checks establish repository and format integrity; behavioral acceptance needs the separate evaluation protocol.

Sources and license

The topic map was inspired by liquidslr/system-design-notes. It does not declare a redistribution license and states its notes draw on commercial books. No prose, diagrams, tables or images from it are included here.

Guidance is independently written from engineering principles and primary sources: AWS Well-Architected, Azure Well-Architected, Google Cloud Well-Architected, Google SRE, OWASP threat modeling and C4.

Original repository content is MIT licensed. Cover provenance and generation prompt are recorded alongside the asset.

About

A vendor-neutral Agent Skill for designing, reviewing, and evolving production-ready software systems through clear requirements, trade-offs, reliability, security, scalability, and rollout planning.

Resources

Contributing

Security policy

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages