Компоненты · Средняя
Документировать контракт компонента
Описать props, события, ограничения и примеры использования компонента.
Быстро понять за 2 минуты
Описать props, события, ограничения и примеры использования компонента. На выходе: есть примеры использования.
Контекст
Пункт относится к этапу «Компоненты». Его задача — создавать повторно используемые компоненты с ясным поведением. Он нужен до передачи результата QA, дизайнеру и владельцу продукта: иначе команда рискует документировать только красивый пример.
Что это дает
Документация снижает неправильное использование компонента и ускоряет onboarding. Это помогает связать работу с общей целью: понятный, быстрый и доступный интерфейс. Практический эффект виден, когда есть примеры использования.
Как выполнить
- Опишите обязательные и опциональные props.
- Добавьте примеры типовых сценариев.
- Зафиксируйте ограничения и accessibility требования.
Критерии приемки
- Есть примеры использования.
- Props понятны без чтения внутреннего кода.
- Ограничения явно указаны.
Типичные ошибки
- Документировать только красивый пример.
- Не описывать controlled/uncontrolled режим.
- Не обновлять docs после изменения API компонента.
Инструменты
Рабочий артефакт
UI inventory
Компоненты: документ с выводом, доказательствами, ответственным и следующим действием
Пример для разработки личного кабинета: специалист начинает с действия «Опишите обязательные и опциональные props». Результат прикладывают к рабочей задаче и передают следующему участнику. Пункт закрывают не по факту обсуждения, а когда выполнено условие: «Есть примеры использования».
- Components
- Variants
- Duplication
- Design tokens
Контроль качества
Карта компонентов
Есть примеры использования.
После изменения пользовательского сценария, дизайна, API-контрактов, релизов и замечаний по доступности.
Сценарий, состояние интерфейса, источник данных, критерии доступности, тесты и ограничения адаптива.
Перед отметкой выполнено: Есть примеры использования.
Как применять
Начинайте с пользовательского действия и состояния интерфейса. Затем проверьте данные, адаптивность, доступность, ошибки и производительность. Хороший frontend-пункт помогает понять, что увидит пользователь, как интерфейс поведет себя в крайних состояниях и чем подтверждается качество реализации.
Режим обучения
Тест по теме
Проверка понимания
Ответьте на вопросы по материалу и получите итоговый отчет: что понято хорошо, а что стоит перечитать.