Design Systems & Component Libraries · Ders

Bileşen Belgelendirme Araçları

Bileşenleriniz için etkileşimli ve yaşayan belgeler oluşturmak üzere Storybook, Styleguidist ve diğer popüler araçları keşfedin.

2. ders / 412 adım

Bileşen Belgelendirme Araçları, CoddyKit'te ücretsiz bir Design Systems & Component Libraries dersidir. Bu, 4 dersinin 2. dersidir. Aşağıdan dersin tamamını ücretsiz okuyabilir, sonra tarayıcıda yerleşik kod editörü ve 7/24 yapay zeka koçu ile uygulamalı olarak pratik yapabilirsin. Bu, Design Systems & Component Libraries öğrenme yolunun bir parçasıdır ve ilerlemeniz web ve CoddyKit uygulaması arasında senkronize olur. Design Systems & Component Libraries kursu toplamda 4 dersten oluşur.

Bu dersin bazı bölümleri henüz çevrilmemiş olup İngilizce olarak gösterilmektedir.

Why Component Documentation Tools?

Design systems thrive on clear, up-to-date documentation. But manually documenting every UI component, their variations, and usage guidelines can be a huge task.

This is where specialized tools come in. They help automate and streamline the process, ensuring your documentation is always consistent and accessible.

Beyond Static Documentation

Static documentation, like simple Markdown files or PDFs, can quickly become outdated. It's hard to visualize how components truly behave without seeing them in action.

Interactive documentation tools allow designers and developers to explore components live, test different properties (props), and understand their full capabilities in a dedicated environment.

Introducing Storybook

Storybook is an open-source tool widely used for developing, testing, and documenting UI components. It provides a dedicated environment, often called a "sandbox" or "workbench," where components can be built and showcased in isolation.

This isolation helps focus on the component itself, free from application-specific logic.

Storybook's Core: Stories

The fundamental concept in Storybook is a "story." A story is a function that renders a single state of a UI component. You write multiple stories for each component to demonstrate all its different variations and use cases.

A Button component might have stories for its default, primary, disabled, and loading states.
A Card component could have stories for different content layouts or data.

Writing a Basic Story

Here's a simplified example of a React button component and how you might write a Storybook story for it. The story demonstrates how to render the component in different states.

import React from 'react';

// A simple Button component
const Button = ({ label, primary, disabled, onClick }) => (
  <button
    style={{
      backgroundColor: primary ? 'blue' : 'gray',
      color: 'white',
      padding: '10px 15px',
      border: 'none',
      borderRadius: '4px',
      cursor: disabled ? 'not-allowed' : 'pointer'
    }}
    disabled={disabled}
    onClick={onClick}
  >
    {label}
  </button>
);

export default Button;

// --- Button.stories.js (simplified) ---
import { StoryFn } from '@storybook/react';
import Button from './Button';

export default {
  title: 'Components/Button',
  component: Button,
};

const Template = ((args) => <Button {...args} />);

export const Default = Template.bind({});
Default.args = {
  label: 'Click Me',
};

export const Primary = Template.bind({});
Primary.args = {
  label: 'Submit',
  primary: true,
};

export const Disabled = Template.bind({});
Disabled.args = {
  label: 'Disabled',
  disabled: true,
};

Storybook Addons & Controls

Storybook's ecosystem of "addons" greatly enhances its utility. Addons extend Storybook's functionality, offering tools for various aspects of component development and documentation:

Controls: Allows users to dynamically change component props in the UI.
Docs: Auto-generates comprehensive documentation from your stories.
Accessibility: Helps check components for common a11y issues.
Actions: Logs events when component callbacks are fired.

Introducing React Styleguidist

React Styleguidist offers a different approach to component documentation. It focuses on creating living style guides with live-editable examples. Unlike Storybook's story-based approach, Styleguidist typically generates a static site based on your components and accompanying Markdown documentation.

Key Features of Styleguidist

Styleguidist is well-suited for teams that prefer a documentation-centric workflow:

Live Editing: Users can modify component code examples directly in the browser, seeing changes instantly.
Markdown-Driven: Documentation is primarily written in Markdown files, often co-located with the components.
Component Sections: Components are organized into logical sections and subsections, making navigation easy.
Auto-Generated Props Tables: Extracts prop types from your components for clear API documentation.

Choosing the Right Tool

Selecting the best documentation tool for your design system depends on several factors:

Tech Stack: Ensure compatibility with your frontend framework (React, Vue, Angular, Svelte, etc.).
Team Workflow: Do designers and developers prefer isolated component development or a more integrated style guide?
Features Needed: Do you require live editing, extensive addons, or just basic component showcases?
Maintenance: Consider how easy it is to integrate, update, and maintain the tool within your existing development workflow.

Documentation Tool Check

Which of these features are commonly found in *either* Storybook or React Styleguidist?

İnteraktif derste cevapla

Recap: Tools for Docs

In this lesson, we explored essential tools for documenting UI components within a design system. We learned that Storybook provides a powerful sandbox for isolated component development and testing, leveraging "stories" and a rich ecosystem of "addons."

We also looked at React Styleguidist, which offers a documentation-first approach with live-editable style guides integrated with Markdown. Choosing the right tool depends on your project's specific tech stack, team workflow, and desired features.

Başlamak ücretsiz

Yapay zeka eğitmeniyle Design Systems & Component Libraries öğren — ücretsiz

Tarayıcında gerçek kod yaz ve çalıştır, 7/24 yapay zeka eğitmeninden anında yardım al; web'de ya da uygulamada kaldığın yerden devam et.

Kurslar: 12
Dersler: 48

Ücretsiz öğrenmeye başla Tüm kursu görüntüle

Sıkça Sorulan Sorular

“Bileşen Belgelendirme Araçları” dersi ücretsiz mi?

Evet — “Bileşen Belgelendirme Araçları” dersin tüm metni burada web'de ücretsiz olarak okunabilir. Etkileşimli olarak pratik yapmak (yerleşik kod editörü ve 7/24 yapay zeka koçu) ve Design Systems & Component Libraries kursunun geri kalanını açmak için CoddyKit PRO'ya yükselt. Design Systems & Component Libraries kursu toplamda 4 dersten oluşur.

“Bileşen Belgelendirme Araçları” dersinde ne öğreneceğim?

Bileşenleriniz için etkileşimli ve yaşayan belgeler oluşturmak üzere Storybook, Styleguidist ve diğer popüler araçları keşfedin. Design Systems & Component Libraries ile uygulamalı kodu tarayıcıda doğrudan çalıştırarak pratik yaparsın ve 7/24 yapay zeka koçu dersi çalışırken sorularını yanıtlar.

Design Systems & Component Libraries öğrenmeye başlamak için deneyim gerekli mi?

Önceden deneyim gerekmez. CoddyKit'te Design Systems & Component Libraries, başlangıçtan ileri seviyeye kadar yapılandırıldığı için buradan başlayabilir veya başından başlayıp kendi hızında ilerleme yapabilirsin. Bu, 4 dersinin 2. dersidir.

“Bileşen Belgelendirme Araçları” dersi ne kadar sürer?

Çoğu CoddyKit dersi yaklaşık 5–10 dakika sürer. Her biri kısa ve etkileşimli olduğu için sabit ilerleme yaparsın ve web ile uygulama arasında tam olarak bıraktığın yerden devam edebilirsin.

Bu Design Systems & Component Libraries dersinde kod yazıp çalıştırabilir miyim?

Evet. Her Design Systems & Component Libraries dersi yerleşik bir kod editörü içerir, bu sayede tarayıcıda gerçek kod yazıp çalıştırabilir ve anlık yapay zeka geri bildirimi alırsın — yerel kurulum gerekli değildir.

Bu kursun tüm dersleri

← Design Systems & Component Libraries Sayfasına Dön