uikit icon indicating copy to clipboard operation
uikit copied to clipboard

doc: Как использовать для каждого компонента

Open arhayka opened this issue 2 years ago • 8 comments

В документации компонентов, где есть примеры использования, сделать вкладку Как использовать и вынести туда все примеры. Например, в Button.

  1. Вынести всё из обзора.
  2. Проверить описание для разработчиков и вынести оттуда рекомендации по использованию тоже.

Пока тексты собираются здесь: 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

arhayka avatar Nov 16 '22 12:11 arhayka

делать вместе с #2853

gizeasy avatar Feb 02 '23 10:02 gizeasy

Таблица компонентов по библиотеке UI kit: https://docs.google.com/spreadsheets/d/1GUxTcaNQj-1sCn-7MU9jVd8KznuB3Bh_OeAme56axFw/edit?usp=sharing

BagenovA avatar May 19 '23 12:05 BagenovA

план:

  1. отметь где надо или не надо
  2. проставить приоритеты
  3. начинаем писать доку

gizeasy avatar May 31 '23 12:05 gizeasy

https://github.com/consta-design-system/uikit/issues/3021

gizeasy avatar Jun 21 '23 07:06 gizeasy

@linturaven @hell0anna проставили в таблице приоритеты компонентов и определились с планом работы.

Примерный план работы:

  1. Ресерч по проблемам, которые встречаются при работе с тем или иным компонентом (Леша, Аня)
  2. Ресерч информации по компонентам и проблемам в других дизайн-системах и написание текста (Настя)
  3. Ревью текста (Леша, Аня)
  4. Определяемся с количеством собранной информации: если текста достаточно - делаем отдельную вкладку на странице компонента и ставим задачу на дизайн соответственно, если инфы мало - помещаем текст в "Обзор" без дизайна. (Настя, Леша, Аня)
  5. Публикация результатов работы на портале (Настя)

*Некоторым компонентам требуется доработка/пересборка (см. таблицу)

BagenovA avatar Jul 07 '23 12:07 BagenovA

@linturaven @hell0anna следующий шаг:

до 17 июля необходимо сделать ресерч по проблемам компонентов приоритета №1 и занести их в таблицу (https://docs.google.com/spreadsheets/d/1GUxTcaNQj-1sCn-7MU9jVd8KznuB3Bh_OeAme56axFw/edit?usp=sharing)

17 июля я выхожу из отпуска и приступаю к работе (на основе собранных проблем).

BagenovA avatar Jul 07 '23 12:07 BagenovA

@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 (если требуется доработка компонента) (Аня, Леша)
  • [ ] Анализ информации и написание текста (Настя)
  • [ ] Ревью текста (Леша, Аня)
  • [ ] Определяемся с количеством собранной информации (Настя, Леша, Аня)
  • [ ] Ставим задачу на создание дизайна, если нужно (Настя, Леша, Аня)
  • [ ] Публикация результатов работы на портале (Настя)

BagenovA avatar Aug 14 '23 12:08 BagenovA

@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 на ревью дизайнеру

linturaven avatar Feb 20 '24 12:02 linturaven