Demos for Doka

Doka is a documentation resource for web developers (like MDN but in Russian).

Task: design and code iframes which are in-built into articles.

Tools: Figma, HTML, CSS, JS, Git

2019 — today

Authors of Doka articles explain how code works. Usually the best way to do it is to demonstrate, not tell. Code examples — demos — are in-built into the articles as a little fully-functioning web-pages via iframe. They can be either static or interactive.

My job is to design these examples so they look consistent and as a natural part of the site. I have to both design and code for this, and this is what I like to do best :)

This demo is availible here.

I treat these code examples as an infographics, meaning they have to show things, not describe with words only. Pretty often I have to dig into the subject first, so to know what should be explained and how it is done best.

In the next example, I cut everything except for the CSS-property which is explained, its values, and effect it makes.

This demo can be found here.

The documentation resource is mostly used by desktop users. However, «Doka» is adaptive and availible for mobile use. My code examples are adaptive too.

By this day I designed more than 350 examples. Most of them are simple, but sometimes a demo can be an entire web-app.

For example, next demo is dedicated to creating an infinite dash scroll, as ones we know by social media. The article author called it a «switter», which sounds similar to both «twitter» and «sweater» in Russian, so I designed it as a sweater :)

You can see this demo here.

design system development

Code samples were scattered in personal accounts of authors when I joined this project. It was hard to see a whole picture back when, so I had to design them one by one. Later I figured out the patterns: which UI elements are used most and how they work better in this project.

Naturally I came to the idea of creating a design system. I knew this tool would ease and fasten my job.

Today the design system is published and is availible for authors and contributors. The system contains all the typical UI elements and code for them.

There is an article about creating Doka design on habr (RU).

I keep working on this project. My part can be seen on doka.guide.

Демки для Доки

Дока — это добрый справочник для веб-разработчиков, написанный с душой на понятном русском языке.

Задача: разработать и применить дизайн для айфреймов, которые встраиваются в статьи.

Инструменты: Figma, HTML, CSS, JS, Git

2019 — по сей день

Авторы Доки в своих статьях объясняют, как работает код, стоящий за всем, что мы видим в своём браузере. Очень часто лучший способ объяснить это показать на примере и дать «потрогать». Примеры — демки — встраиваются в статьи как небольшие, но полноценные веб-страницы, которые бывают как статичными, так и интерактивными (реагирующими на действия читателя).

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

Демо доступно для просмотра на сайте.

Я воспринимаю демо-пример как инфографику: он должен показывать, а не рассказывать. Часто приходится сначала разобраться в теме, чтобы понять, как не просто оформить пример, а сделать его лучше.

В примере справа я отсекла всё лишнее, и оставила только название CSS-свойства, которое нужно было проиллюстрировать, значения, которые оно принимает, и эффект, который это свойство создаёт.

Демо доступно здесь.

В справочник по веб-технологиям чаще всего заходят с компьютеров во время работы. Однако «Дока» адаптивна и доступна с мобильных устройств. Чтобы демо-примеры тоже подстраивались под разрешение браузера, я верстаю их адаптивно.

К настоящему времени я оформила около 350 примеров. Большинство из них похожи между собой, но бывают и исключения — настоящие веб-приложения, со своей собственной легендой и функциями.

Пример справа посвящён созданию бесконечной ленты как в соцсетях. Автор статьи назвал пример switter, а я подхватила идею и оформила его как свитер :)

Демо доступно здесь.

Разработка дизайн системы

Когда я присоединилась к проекту, примеры были разрозненными фрагментами кода на личных аккаунтах авторов статей. Я начала оформлять их один за другим, и постепенно отследила закономерности: какие элементы дизайна часто встречались, какие оформительские приёмы лучше всего работали именно в маленьких демках.

Естественным образом я пришла к необходимости создания дизайн-системы как инструмента, который, в первую очередь, облегчил и ускорил бы мою собственную работу.

Сегодня дизайн-система опубликована и доступна для авторов и контрибьюторов Доки. Система содержит описания типовых элементов, встречающихся в демках, и готовый код для них. Мне это позволило перейти от роли единственного человека, создающего демки, к роли ревьюера.

О командной работе над дизайном Доки вышла статья на habr.

Работа над эти проектом продолжается по сей день, вы можете увидеть его весь и мой вклад на сайте doka.guide.