system-design
Use when designing system architecture, APIs, components, or data models - provides a structured design workflow with validation and documentation outputs.
When & Why to Use This Skill
This Claude skill provides a structured and validated workflow for designing complex system architectures, APIs, and data models. It helps engineers transition from raw requirements to professional design documentation while ensuring adherence to best practices and technical constraints, significantly reducing architectural debt.
Use Cases
- High-Level System Architecture: Designing scalable and resilient system structures for new software projects or microservices migrations.
- API and Schema Specification: Defining robust API interfaces and data models to ensure consistency and interoperability across different services.
- Technical Documentation: Generating comprehensive design specifications, diagrams, and validation notes for team reviews and stakeholder alignment.
- Constraint-Based Validation: Evaluating architectural decisions against specific business requirements and technical constraints to identify potential bottlenecks early.
| name | system-design |
|---|---|
| description | Use when designing system architecture, APIs, components, or data models - provides a structured design workflow with validation and documentation outputs. |
System Design
Overview
Create clear system, API, component, or data model designs with explicit requirements, constraints, and validation steps.
When to Use
- Designing system architecture or components
- Specifying APIs or data models
- Producing design docs or diagrams
Avoid when:
- You only need implementation tasks (use implementation-workflow)
Quick Reference
| Task | Load reference |
|---|---|
| System design workflow | skills/system-design/references/system.md |
Workflow
- Gather requirements and constraints.
- Load the system design reference.
- Define structure, interfaces, and data flows.
- Validate against constraints and best practices.
- Deliver spec/diagram/code artifacts.
Output
- Design spec or diagram
- Validation notes and follow-ups
Common Mistakes
- Designing without constraints
- Mixing implementation details with spec scope