Составление документации по компонентам дизайн-системы

Требуется подготовить документацию для библиотеки виджетов — одной из составляющих корпоративной дизайн-системы.

В компании создается библиотека компонентов интерфейса, которая упростит процесс разработки IT-продуктов: удешевит стоимость и сократит время на разработку интерфейсов. Разработчик или дизайнер сможет брать нужный ему компонент из библиотеки вместо того, чтобы создавать его с нуля. Для каждого компонента дизайн-системы должна быть подготовлена документация, которая включает в себя описание компонента, варианты его использования, модификации, список свойств и пример использования. Часть документации уже готова, сделано описание основных компонентов дизайн-системы. Теперь необходимо подготовить документацию для компонентов дополнительной библиотеки (библиотеки виджетов), которая поможет дизайнерам и разработчикам правильно использовать элементы библиотеки. Вы будете работать над документацией к библиотеке виджетов, в которую входят такие компоненты, как линейные графики, столбчатые диаграммы, круговые диаграммы, прогресс-бары и т. п.

Проект рассчитан на то, что им будет заниматься один человек — копирайтер.

1. Изучить имеющиеся материалы: • имеющуюся документацию по компонентам; • библиотеку виджетов; • общие правила при работе с библиотекой (оформление кода, работа с git, правила задания размеров и стилей и т. д.). 2. Согласовать структуру и стиль написания документации с лидером проекта. 3. Написать документацию по всем компонентам библиотеки виджетов в соответствии с принятыми в компании правилами оформления документации и с учетом целевой аудитории (дизайнеры и разработчики, использующие библиотеку). 4. По каждому компоненту сделать запрос на включение (pull request) финальной согласованной версии документации в репозиторий проекта дизайн-системы.

1. Документация к библиотеке виджетов по всем компонентам и их модификациям, выполненная в соответствии с принятой в компании стилистикой. 2. Одобрены запросы на включение описаний в репозиторий дизайн-системы компании (1 описание — 1 запрос на включение).

1. Создана документация по 20 основным компонентам и их модификациям. 2. Тексты написаны простым языком и соответствуют требованиям к структуре и стилистике написания, принятым в компании. 3. Каждый компонент и все его модификации полностью описаны. 4. Все замечания и поправки, возникшие в ходе проекта, учтены. 5. Все отправленные пул реквесты по написанной документации проверены и приняты экспертами компании (дизайнерами и разработчиками).

Проект предусматривает денежное вознаграждение в размере 70 000 рублей после выплаты налогов.

1. Лидер проекта передаст вам в качестве примера структуры уже имеющуюся документацию по компонентам дизайн-системы (описание кнопок, тачбаров и т.д.), 2. а также общую документацию (принципы работы, стилистика, правила пользования git и т.д.), 3. Эксперты компании ответят на имеющиеся вопросы.