Запустилась Дока — опенсорсный справочник по веб-разработке

Kate · 20 Окт 2021

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

Это открытый проект, внести вклад в него может каждый. Контент и код Доки лежат на GitHub, правила участия, обсуждения и ревью проходят открыто для всех желающих.

Яндекс.Практикум поддерживает работу редакции Доки.

Как появилась идея Доки

Идея создать «добрую» документацию, в которой статьи будут написаны на понятном и несложном техническом языке, зародилась внутри Яндекс.Практикума в 2019 году. Тогда же появилась первая редакция и первые тексты. В конце 2020 года Дока стала активно развиваться, а 12 октября запустилась как независимый проект.

Осенью 2020-го ко мне пришёл Андрей Уродов из Практикума и предложил заняться проектом доброй документации для сообщества. Помню, меня тогда поразило слово «добрый», оно немного выпадало по смыслу, но когда я посмотрел на команду и подачу, я понял, о чём речь. Я всегда чувствовал эту болевую точку про источник знаний о веб-платформе и понимал, что это не просто безумная идея, а реальная потребность.

Я давно занимался «Веб-стандартами» — первым русскоязычным фронтенд-сообществом — и для меня это было понятным и интересным делом. Отдельно меня привлекла возможность поработать над опенсорсным проектом, в котором может принять участие любой желающий. Я подхватил эту идею и дожал её до полной открытости и публичности, чтобы проект не просто приносил пользу сообществу, но и развивался силами сообщества максимально прозрачно.

Вадим Макеев,
главный редактор Доки

Зачем нужна Дока

Главная задача Доки — предоставить веб-разработчикам понятные справочные материалы на русском языке, которые хорошо и нескучно написаны. Дока может быть полезна и тем, кто учится разработке, и тем, кто уже работает. Начинающим разработчикам она поможет разобраться в терминах, а уже прокачанным ребятам даст возможность делиться опытом и обмениваться знаниями.

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

Задача Доки — в том, чтобы помочь новичкам не разочароваться в себе и предмете. В том, чтобы разработчики с опытом знали место, где можно найти ответы на профессиональные вопросы. И в том, чтобы культура обмена опытом, диалога о программировании двигалась в сторону продуктивной простоты и соответствовала тому запросу, который давно на виду.

Сергей Нугаев,
руководитель направления программирования в Яндекс.Практикуме

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

Задача Доки — стать источником правды по веб-платформе для русскоязычного сообщества. В вебе есть много документации: от формальных спецификаций до развязных статей в личных блогах. Что найдёшь — тому и веришь. Как добавить свою каплю опыта в это море — не очень понятно. Плюс всё на английском языке, что становится не только барьером для тех, кто не знает язык, но и сдерживает тех, кто язык знает — нюансы часто теряются при чтении или переводе.

Другая сложность — как делиться опытом. Если напишешь пост в личный блог, даже на Хабр или Медиум, то высок шанс, что он потеряется со временем. Или даже хуже — не потеряется, но страшно устареет за пару лет. А тут можно так поделиться опытом, что это всегда будет на виду и любой сможет поправить то, что кажется некорректным.

Вадим Макеев,
главный редактор Доки

Как устроена Дока

Дока состоит из четырёх разделов: HTML, CSS, JavaScript и Инструменты.

В каждом разделе есть два типа статей. Дока — небольшая статья справочного характера. Статья — более объёмный материал, в котором автор рассуждает про какую-нибудь парадигму программирования, рассказывает о происхождении процесса, функции, тега.

Сейчас на сайте опубликовано 1011 статей.

Например, статья про grid

Команда проекта

Сейчас в команде 11 человек. Главный редактор проекта — Вадим Макеев, редактор разделов HTML и CSS — Алёна Батицкая, редактор разделов JavaScript и Инструменты — Николай Лопин, ревьюер разделов JavaScript и Инструменты — Саша Беспоясов, литературный редактор — Ольга Алексашенко.

Помимо редакторов, в команде Доки арт-директор Валя Броницкая, иллюстратор Кира Кустова, дизайнер Света Коробцева, бэкенд-разработчик Игорь Коровченко, фронтенд-разработчик Алексей Бузмаков и амбассадор в сообществе Егор Левченко.

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

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

Теперь, после запуска, Практикум поддерживает независимую редакцию Доки, которая руководствуется своим желанием и целью сделать вместе с сообществом (и для сообщества) понятный, полезный и красивый справочник.

Сергей Нугаев,
руководитель направления программирования в Яндекс.Практикуме

Как принять участие в проекте

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

Дока во многом — эксперимент, так что мы, конечно же, хотим понять, пригодимся ли мы сообществу, будет ли просто и полезно контрибьютить в такую опенсорсную документацию. Это понятно, любой новый проект немного сомневается. Но мы уверены, что нужно развивать контент, описывать веб-платформу шире и глубже, запускать новые разделы. У нас уже есть мысли про раздел SVG по векторной графике, про доступность. Ну и, конечно, мероприятия, которые помогут нас лучше узнать и научиться контрибьютить в Доку — митапы и хакатоны, которые мы запустим уже в ближайшее время.

Вадим Макеев,
главный редактор Доки