🎨 Design Systems

Dokumentacja komponentu — co to jest?

Opis komponentu zawierający jego przeznaczenie, dostępne warianty, propsy, wytyczne użycia, przykłady i sytuacje, w których nie należy go stosować.

Jak to działa?

Dobra dokumentacja komponentu odpowiada na pytania: kiedy go użyć, kiedy nie użyć, jakie ma warianty i jak wygląda w różnych kontekstach. Na przykład dokumentacja komponentu Modal może zawierać: opis ("do decyzji wymagających potwierdzenia"), warianty (confirmation, destructive, informational), wytyczne ("nie używaj do długich formularzy") i przykłady kodu. Najczęściej żyje w Storybooku lub na dedykowanej stronie Design Systemu.

Dlaczego to ważne?

Bez dokumentacji nowi członkowie zespołu muszą zgadywać, jak używać komponentów. To prowadzi do błędnego użycia, duplikatów i frustracji.