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