agentleFS
nisarthnisarth/claude-skills-store/skills/design/design-system/SKILL.md

design-system

Skill1 starsChanged 7 months agoMITView on GitHub

Audit, document, or extend your design system. Use when checking for naming inconsistencies or hardcoded values across components, writing documentation for a component's variants, states, and accessibility notes, or designing a new pattern that fits the existing system. Trigger phrases: "design system audit", "document this component", "design system review", "naming conventions", "add to design system", "component documentation", "design tokens", "pattern library", "extend the design system", "system consistency"

193 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use setup-engine, team-level and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • CoralGameSkill

    setup-engine

    Configure the project's game engine and version. Pins the engine in CLAUDE.md, detects knowledge gaps, and populates engine reference docs via WebSearch when the version is beyond the LLM's training data.

    Also in 13 projects that use this

  • CoralGameSkill

    team-level

    Orchestrate level design team: level-designer + narrative-director + world-builder + art-director + systems-designer + qa-tester for complete area/level creation.

    Also in 12 projects that use this

  • lilangMaxSkill

    create-stories

    Break a single epic into implementable story files. Reads the epic, its GDD, governing ADRs, and control manifest. Each story embeds its GDD requirement TR-ID, ADR guidance, acceptance criteria, story type, and test evidence path. Run after /create-epics for each epic.

    Also in 11 projects that use this

  • lilangMaxSkill

    story-done

    End-of-story completion review. Reads the story file, verifies each acceptance criterion against the implementation, checks for GDD/ADR deviations, prompts code review, updates story status to Complete, and surfaces the next ready story from the sprint.

    Also in 11 projects that use this

  • +2 more from CoralGame
  • +6 more from lilangMax

The file

We split this skill into the rules it gives an agent

8 rules. 0 are common, 7 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 175 edited versions we read keep these.

  • 7

    Distinctive

    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 template for each component:

    line 71
  2. Distinctive:

    When adding a new component or pattern:

    line 103
  3. Distinctive:

    Design all states: Before documenting, ensure these are designed:

    line 116
  4. Distinctive:

    Default, Hover, Active, Focus, Disabled

    line 117
  5. Distinctive:

    Response: Write the full component doc including purpose, anatomy (overlay, container, header, body, footer), variants (default, alert, …

    line 157
  6. Very specific:

    Semantic naming over visual naming: Use color-text-primary not color-dark-gray.

    line 165
  7. Distinctive:

    Version components: When making breaking changes, version the component API so consumers can migrate gradually.

    line 168
  8. Distinctive:

    Accessibility is not optional: Every component needs keyboard behavior, screen reader support, and focus management documented.

    line 172

“Common” is measured: kept by at least 6 in 10 of the 175 edited versions of this file we could read. “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

Design System Management

Audit, document, and extend design systems. Ensure naming consistency, comprehensive component documentation, and patterns that scale.

Workflow

Step 1: Determine the Task

Task TypeApproach
AuditReview existing system for inconsistencies, gaps, and technical debt
DocumentWrite or improve documentation for existing components
ExtendDesign a new component or pattern that fits the system
RefactorRename, restructure, or consolidate existing patterns

Step 2: Audit the System (if auditing)

Check each layer:

Token Audit

### Token Consistency Check

#### Colors
- [ ] Named semantically (color-text-primary, not color-gray-900)
- [ ] No hardcoded hex values in components
- [ ] Dark mode / theme-aware tokens exist
- [ ] Consistent naming pattern (color-{usage}-{variant})

#### Typography
- [ ] Type scale follows a consistent ratio
- [ ] No orphan font sizes outside the scale
- [ ] Font weights are tokenized (not raw 400, 600)
- [ ] Line heights are paired with font sizes

#### Spacing
- [ ] Spacing scale is consistent (4px base, 8px increments, etc.)
- [ ] No arbitrary spacing values in components
- [ ] Spacing tokens used for margin and padding

#### Shadows, Radii, Borders
- [ ] Consistent elevation system (shadow-sm, shadow-md, shadow-lg)
- [ ] Border radius values are tokenized
- [ ] Border colors reference color tokens

Component Audit

### Component Consistency Check

| Component | Naming | Variants | States | A11y | Docs | Score |
|-----------|--------|----------|--------|------|------|-------|
| Button | OK | Full | Full | Yes | Yes | 5/5 |
| Input | OK | Partial | Missing error | No | Partial | 2/5 |
| Card | Inconsistent | None | None | No | No | 1/5 |

Score components on: naming consistency, variant coverage, state coverage, accessibility attributes, and documentation quality.

Step 3: Document Components (if documenting)

Use this template for each component:

## [Component Name]

### Purpose
[One sentence: what this component is for and when to use it]

### When to Use
- [Use case 1]
- [Use case 2]

### When NOT to Use
- [Anti-pattern 1]: Use [Alternative] instead
- [Anti-pattern 2]: Use [Alternative] instead

### Anatomy, Variants, States, Props, Accessibility

Document each component's anatomy (parts and their roles), variants (visual options with purpose), states (default through loading with visual changes), props/API (type, default, description), and accessibility requirements (ARIA role, keyboard behavior, screen reader announcements, focus management).

### Usage Examples
[Code examples showing common usage patterns]

### Do's and Don'ts
| Do | Don't |
|----|-------|
| Use for primary page actions | Use more than one primary button per section |
| Include clear, action-oriented labels | Use vague labels like "Click here" |

Step 4: Extend the System (if adding)

When adding a new component or pattern:

  1. Check for existing patterns. Does something similar already exist? Can an existing component be extended instead?
  2. Follow the naming convention. Match the existing system's naming patterns:
    Existing: Button, ButtonGroup, IconButton
    New: LinkButton (follows pattern)
    Wrong: BtnLink (breaks pattern)
  3. Use existing tokens. New components should reference existing tokens, not introduce new values.
  4. Design all states. Before documenting, ensure these are designed:
    • Default, Hover, Active, Focus, Disabled
    • Loading, Empty, Error (where applicable)
    • Responsive variants (if layout changes at breakpoints)
  5. Define composition rules. How does this component work with others?

Step 5: Compile the Output

For audits:

## Design System Audit: [System Name]
Date: [Date]

### Summary
- **Components audited**: [N]
- **Issues found**: [N critical, N major, N minor]
- **Overall health**: [Good / Needs work / Significant gaps]

### Token Issues
[Findings]

### Component Issues
[Findings with priority]

### Recommendations
1. [Action item with priority]
2. [Action item with priority]

### Roadmap
[Suggested order of improvements]

Examples

Example 1: System Audit

User: "Audit our design system for consistency issues." Response: Review tokens for naming patterns and orphan values. Check each component for state coverage and documentation. Identify hardcoded values that should be tokens. Report findings ranked by impact.

Example 2: Component Documentation

User: "Document our Modal component." Response: Write the full component doc including purpose, anatomy (overlay, container, header, body, footer), variants (default, alert, confirmation), states (opening, open, closing), props, accessibility (focus trap, Escape to close, aria-modal), and composition with other components.

Example 3: New Pattern

User: "We need an empty state pattern for our design system." Response: Review how other empty states in the product look (if any). Propose a pattern with: illustration slot, heading, body text, and CTA button. Define variants (first-time, no results, error). Document sizing, spacing using existing tokens, and when to use each variant.

Best Practices

  1. Semantic naming over visual naming. Use color-text-primary not color-dark-gray. Semantic names survive theme changes and rebrands.
  2. Document the why, not just the what. "Use Primary for the single most important action on a screen" is more useful than "Primary: blue button."
  3. Include anti-patterns. Showing what not to do is as valuable as showing what to do. Developers reference these when making decisions.
  4. Version components. When making breaking changes, version the component API so consumers can migrate gradually.
  5. Audit regularly. Design systems drift as products evolve. Quarterly audits catch inconsistencies before they compound.
  6. Single source of truth. Tokens should be defined once and consumed everywhere. If a token changes, it should propagate automatically.
  7. Design for composition. Components should combine predictably. Test common compositions and document how components work together.
  8. Accessibility is not optional. Every component needs keyboard behavior, screen reader support, and focus management documented. This is a baseline, not an enhancement.

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.