Przejdź do treści
Biblioteka skilli
Projektowanie i UX · Pisanie

design-system-doc

/design-system-doc

Dokumentuje komponent, wzorzec lub token systemu projektowego dla całego zespołu: wpis do biblioteki komponentów, style guide i dokumentacja tokenów.

Repozytorium
claude-skills ↗
Licencja
MIT
Ostatnia zmiana repozytorium
19.10.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
1
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 19.10.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co robi i kiedy

Dokumentuje komponent, wzorzec lub token systemu projektowego dla całego zespołu: wpis do biblioteki komponentów, style guide i dokumentacja tokenów.

Wyzwalacze z opisu

design system docsdocument this for the design systemadd this to the design systemdesign tokencomponent library docsstyle guidedesign system entryt explicitly say
Oryginalny opis (EN)

Document a design system component. Use when the user says "design system docs", "document this for the design system", "add this to the design system", "design token", "component library docs", "style guide", "design system entry", or wants to formally document a pattern, component, or token for team-wide use - even if they don't explicitly say "design system".

Jak działa

  1. Overview
  2. Workflow
  3. Anti-Patterns
  4. Quality Checklist
Sekcje z nagłówków SKILL.md, w oryginale · 114 linii, 668 słów
Podgląd SKILL.md
---
name: design-system-doc
description: >
  Document a design system component. Use when the user says "design system docs",
  "document this for the design system", "add this to the design system",
  "design token", "component library docs", "style guide", "design system entry",
  or wants to formally document a pattern, component, or token for team-wide use
  - even if they don't explicitly say "design system".
---

## Overview

Based on **"Atomic Design"** by Brad Frost. A design system is not a component library - it's a shared language. Frost's insight: components without documentation are just code. Documentation is what transforms a component library into a system that a whole team can use consistently without needing to ask the original designer.

Design system documentation has two audiences: designers who need to use the pattern correctly, and engineers who need to implement it accurately. Write for both.

## Workflow

### Step 1: Establish the entry structure
Every design system entry should follow the same structure so team members can predict where to find information:

```
1. Overview (what this is, one paragraph)
2. When to use / when not to use
3. Anatomy (labeled diagram of all parts)
4. Variants
5. States
6. Design tokens used
7. Usage examples (correct and incorrect)
8. Accessibility
9. Related components
10. Changelog
```

### Step 2: Write the overview
One paragraph: what is this component/pattern? What job does it do in the UI?

Include a simple visual (or Figma embed) showing the component in its default state.

### Step 3: When to use / when not to use
This is the most important section. Design systems fail when components are used outside their intended context.

```
Use when:
- [specific context 1]
- [specific context 2]

Don't use when:
- [anti-context 1] - use [alternative] instead
- [anti-context 2] - use [alternative] instead
```

### Step 4: Document the anatomy
Label every part of the component. Each part should have:
- A name (used consistently in code and design)
- Whether it's required or optional
- Constraints (max length, image dimensions, etc.)

### Step 5: Document design tokens
List every token the component uses:

| Token | Value | Role |
|-------|-------|------|
| `color.interactive.primary` | `#0066CC` | Background color |
| `spacing.md` | `16px` | Internal padding |
| `radius.sm` | `4px` | Border radius |
| `typography.body.md` | `16px / 24px` | Label text |

Using tokens (not hardcoded values) ensures the component responds correctly to theme changes in [your design system].

### Step 6: Add usage examples
Show correct and incorrect usage with visual examples:

Correct: [example with explanation of why it's correct]
Incorrect: [example with explanation of why it's wrong and what to do instead]

At least 2-3 of each. Real examples beat abstract rules.

### Step 7: Document accessibility
- Keyboard interactions
- Screen reader behavior
- Required ARIA attributes
- Color contrast compliance (WCAG AA)
- Touch target size compliance

### Step 8: Add a changelog
Every time the component changes, log it:

```
v1.2 - [date] - Added loading state. [your team]
v1.1 - [date] - Updated border radius to match new tokens. [your team]
v1.0 - [date] - Initial release. [your team]
```

## Anti-Patterns

**1. Documentation written only for designers**
Bad: Docs describe visual design but no tokens, props, or accessibility.
Good: Document at both design and implementation level. Engineers should be able to build from the doc alone.

**2. No "when not to use" section**
Bad: Only positive usage guidance.
Good: "When not to use" prevents misuse and is often more valuable than "when to use."

**3. Hardcoded values instead of tokens**
Bad: Component documented with hex codes and pixel values.
Good: Everything references a named token. Tokens are the vocabulary of [your design system].

**4. No changelog**
Bad: Component updated silently.
Good: Every change logged with version, date, and author. [Your team] can see what changed and when.

## Quality Checklist

- [ ] Standard entry structure followed (overview through changelog)
- [ ] When to use AND when not to use documented
- [ ] Anatomy labeled with names used in both design and code
- [ ] All design tokens documented (not hardcoded values)
- [ ] Correct and incorrect usage examples included
- [ ] Accessibility: keyboard, screen reader, ARIA, contrast
- [ ] Changelog entry added for this version
- [ ] Related components cross-referenced

Wersje

W bazie nie ma innych skilli o nazwie design-system-doc.

Migawka bazy z 13.11.2026 · wersja paczki 01fbccda7810 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100core-components
    Opisuje wzorce biblioteki komponentów i systemu projektowego, przy budowaniu interfejsu z tokenami projektowymi.
  • 100core-components
    Opisuje wzorce biblioteki komponentów i systemu projektowego, przy budowaniu interfejsu z tokenami projektowymi.
  • 100core-components
    Opisuje wzorce biblioteki komponentów i systemu projektowego, przy budowaniu interfejsu z tokenami projektowymi.
  • 100core-components
    Opisuje wzorce biblioteki komponentów i systemu projektowego, przy budowaniu interfejsu z tokenami projektowymi.
  • 100design-systems-architecture
    Projektuje architekturę systemu projektowego: tokeny W3C, potoki Style Dictionary, strukturę biblioteki komponentów, motywy, warstwy tokenów wielu marek, governance, wersjonowanie i modele dojrzałości.
  • 100code-showcase-core-components
    Opisuje wzorce biblioteki komponentów i systemu projektowego, w tym tokeny projektowe, przy budowie interfejsu.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.