uikit
uikit copied to clipboard
doc: Как использовать для каждого компонента
В документации компонентов, где есть примеры использования, сделать вкладку Как использовать и вынести туда все примеры. Например, в Button
.
- Вынести всё из обзора.
- Проверить описание для разработчиков и вынести оттуда рекомендации по использованию тоже.
Пока тексты собираются здесь: https://www.figma.com/file/GHfK2MTZYaGpSxT7Imv0gM/Consta%3A-%D0%A0%D0%B5%D0%B4%D0%B8%D0%B7%D0%B0%D0%B9%D0%BD-%D0%BF%D0%BE%D1%80%D1%82%D0%B0%D0%BB%D0%B0?node-id=103%3A5937&t=tXvB6MXFF1RQHMEj-1
делать вместе с #2853
Таблица компонентов по библиотеке UI kit: https://docs.google.com/spreadsheets/d/1GUxTcaNQj-1sCn-7MU9jVd8KznuB3Bh_OeAme56axFw/edit?usp=sharing
план:
- отметь где надо или не надо
- проставить приоритеты
- начинаем писать доку
https://github.com/consta-design-system/uikit/issues/3021
@linturaven @hell0anna проставили в таблице приоритеты компонентов и определились с планом работы.
Примерный план работы:
- Ресерч по проблемам, которые встречаются при работе с тем или иным компонентом (Леша, Аня)
- Ресерч информации по компонентам и проблемам в других дизайн-системах и написание текста (Настя)
- Ревью текста (Леша, Аня)
- Определяемся с количеством собранной информации: если текста достаточно - делаем отдельную вкладку на странице компонента и ставим задачу на дизайн соответственно, если инфы мало - помещаем текст в "Обзор" без дизайна. (Настя, Леша, Аня)
- Публикация результатов работы на портале (Настя)
*Некоторым компонентам требуется доработка/пересборка (см. таблицу)
@linturaven @hell0anna следующий шаг:
до 17 июля необходимо сделать ресерч по проблемам компонентов приоритета №1 и занести их в таблицу (https://docs.google.com/spreadsheets/d/1GUxTcaNQj-1sCn-7MU9jVd8KznuB3Bh_OeAme56axFw/edit?usp=sharing)
17 июля я выхожу из отпуска и приступаю к работе (на основе собранных проблем).
@hell0anna @linturaven Как и договаривались на планировании, делим задачу на три блока по приоритетам компонентов. В комментарии выше уже описан план работы, я взяла его за основу и расписала шаги подробнее.
Чек-лист для блока №1:
- [x] Провести опрос среди дизайнеров и контрибьютеров, чтобы узнать о проблемах в использовании компонентов (Настя) (https://docs.google.com/spreadsheets/d/1ypBWKQ6fujYOiFB6A11OHbhASumj5pnFPAjKwIKrqYc/edit?usp=sharing)
- [ ] По результатам опроса выделить респондентов для интервью и назначить встречи (Аня, Леша)
- [ ] Провести интервью с респондентами, зафиксировать проблемы по компонентам 1 приоритета (и любых других, которые будут озвучены на интервью) в таблицу: https://docs.google.com/spreadsheets/d/1GUxTcaNQj-1sCn-7MU9jVd8KznuB3Bh_OeAme56axFw/edit?usp=sharing (Аня, Леша)
- [ ] Собранные материалы оформить в задачи на GitHub (если требуется доработка компонента) (Аня, Леша)
- [ ] Анализ информации и написание текста (Настя)
- [ ] Ревью текста (Леша, Аня)
- [ ] Определяемся с количеством собранной информации (Настя, Леша, Аня)
- [ ] Ставим задачу на создание дизайна, если нужно (Настя, Леша, Аня)
- [ ] Публикация результатов работы на портале (Настя)
@alyonurchick1
В ходе выполнения задачи нужно завести задачу под каждый компонент в формате [номер эпика] Название компонента: как использовать. Компоненты, которые требуют описания:
- [ ] AutoComplete — https://github.com/consta-design-system/uikit/issues/3641
- [ ] AutoComplete (Multiple) — https://github.com/consta-design-system/uikit/issues/3641
- [ ] Chips — https://github.com/consta-design-system/uikit/issues/3640
- [ ] BookmarkTabs — https://github.com/consta-design-system/uikit/issues/3639
- [ ] SnackBar — https://github.com/consta-design-system/uikit/issues/3638
- [ ] Select — https://github.com/consta-design-system/uikit/issues/3637
- [ ] Combobox — https://github.com/consta-design-system/uikit/issues/3636
- [ ] List — https://github.com/consta-design-system/uikit/issues/3635
- [ ] ContextMenu — https://github.com/consta-design-system/uikit/issues/3634
- [ ] Tag — https://github.com/consta-design-system/uikit/issues/3633
План действий:
- [ ] Изучить механику работы компонента
- [ ] Проконсультироваться с дизайнером на предмет частых ошибок в части использования
- [ ] Получить от дизайнера кейсы использования
- [ ] Сформировать описание для портала (можно частично использовать описание из Figma)
- [ ] Запросить у дизайнера макеты для примеров «правильно/не правильно» (если надо)
- [ ] Заполнить раздел на портале у конкретного компонента
- [ ] Передать PR на ревью дизайнеру