Войти с помощью github
Форум /

Всем привет!

Мне не терпится поделиться с вами впечатлениями от прошедшего первого Хакатона по БЭМ! Это был первый хакатон в моей жизни, и мне довелось сразу побывать «в шкуре» ментора. Признаюсь, мне понравилось :)

Обо всем по порядку:

Предыстория

Для начала расскажу о себе:

Меня зовут Инна Белая, и я руковожу группой разработки технической документации. Уже почти год мы, технические писатели, вместе с командой разработчиков ведем к «светлому будущему» документацию БЭМ. Путь этот тернист и ухабист, но мы стараемся :) Пишем, переводим, следим за пожеланиями пользователей и стремимся стать понятней.

Когда появилась возможность познакомиться и тем более плотно поработать в команде с ребятами из нашего сообщества, я с радостью согласилась. Такая работа открывала двери к разработчикам и позволяла:

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

Работа ментора — нелегкая. До хакатона нужно было проделать предварительную работу и понять, какие проблемы нам предстоит решить.

Я наметила следующее:

  • недостаток информации о продуктах;
  • большие объемы текущей документации;
  • сложный язык, который не упрощает понимание сложных технологий;
  • двуязычность.

От этих проблем и было решено отталкиваться при постановке задач на хакатон, и

  • пересмотреть структуру сайта bem.info, чтобы дать полное представление о методологии БЭМ, платформе (библиотеках, инструментах, технологиях) и сообществе продукта, облегчить поиск и восприятие информации;
  • выработать основные принципы подачи материала на сайте;
  • по возможности сделать недостающие переводы документов.

Время хакатона пришло!

Немного общих хороших слов :)

Программа хакатона была правильно спланирована: все участники познакомились и пообщались еще до официального открытия. Были теплый совместный ужин и экскурсия по московскому офису Яндекса. Когда встретились на второй день, не было неловкости из-за обилия незнакомых лиц. Хотя все немного нервничали в предвкушении предстоящих задач и презентаций проектов, приветствие Елены Джетпыспаевой (более знакомой всем как Мурся) и Вовы Гриненко оказалось настолько душевным и неформальным, что все моментально переключились на эту волну. Заряда позитива хватило на все долгие 48 часов.

Презентация проекта и формирование команд

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

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

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

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

Работа в команде, задачи, процесс

Моя команда выбрала просторную комнату и разделила ее с другой командой. Работа началась. Для меня было большим удивлением, что в команду документирования записался разработчик, знающий и использующий полный БЭМ-стек! Да такого участника хотела бы заполучить каждая команда! Это накладывало дополнительную ответственность на нас :)

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

Изначально ставили две основные задачи:

  1. пересмотреть структуру сайта bem.info и понять, где именно она может быть неудобной;
  2. выработать основные принципы подачи материала на сайте, чтобы он помогал разработчикам.

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

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

В первую очередь решили опросить участников хакатона, затем обратиться к сообществу. Создали анкету обратной связи и попросили всех участников хакатона ответить. Отдельное спасибо всем, кто откликнулся на наш призыв и нашел пять минут среди своих напряженных задач, и прислал нам свои ответы. Это сделало на удивление большинство! Данные продолжали поступать в течение всего хакатона, даже в три часа ночи и в восемь утра! Ребята, вы молодцы! Спасибо!

Вот что мы узнали из анкет:

  • практически половине участников хватает существующей информации («Хватает ли тебе технической информации на сайте bem.info?» Да – 41% / Нет – 59%);
  • не хватает в основном пошаговых руководств по «настройке и тюнингу на продакшене», «использованию с backend-фреймворками», по «настройке сборки примеров и тестов», «по i-bem.js — по всем методам с примерами», видеоуроков, «простого туториала», «навигации по документам»;
  • с БЭМ помогает работать документация по технологиям, BEMHTML reference, документация по библиотекам и быстрый старт с project-stub;
  • популярностью пользуются такие разделы сайта bem.info, как «Технологии» – 24%, «Библиотеки» – 24%, «Форум» – 16%, «Инструменты» – 11%, «Выступления» – 10%, «Статьи» – 8%, «Методология» – 6%;
  • большая часть опрошенных считает документацию на сайте сложной для понимания – 74% против 26%;
  • разработчики отдают предпочтение объемным, хорошо структурированным документам (36%) и мастер-классам (26%). Многие не против обучающих роликов (19%), а к сжатой документации готовы только 17%;
  • все опрошенные в той или иной степени сошлись на том, что сайту не хватает интерактивных примеров и руководств, видеоматериалов и графической поддержки текстовых материалов;
  • и что очень порадовало – среди прочих были и такие ответы: «За год проделана огромная работа по реструктуризации и дополнению документации, она стала ГОРАЗДО лучше, спасибо вам!».

Подход с делегированием задач оказался достаточно эффективным: еще до ужина у нас была определена новая структура и основные принципы подачи материала, которым мы хотим следовать в будущем. Конечно, это только предложение, которое нужно доработать и утвердить с командой разработчиков БЭМ.

По меркам хакатона у нас осталось море времени, чтобы разобраться с проблемными местами. Мы решили перевести документацию, которую все давно ждали. Миша Баранов взялся за переводы! А мы добавили его на страницу авторов, ведь переводы опубликованы под его именем :) Спасибо большое!

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

Утро у многих было сонным, встретились на кофепоинте, обсуждали проекты. Времени оставалось все меньше. Нужно было закончить работу и оформить результаты в презентацию проектов.

Мы решили, что вполне успеем начать работу еще над одним документом. Идея родилась после ответов на нашу анкету, где довольно часто упоминали о том, что существующий «быстрый старт по БЭМ» не слишком быстрый. Мы решили заняться этой задачей. Работали сообща, чтобы успеть как можно больше! Вика писала текст, Миша писал код, я оформляла результаты двух дней в финальную презентацию проекта.

Презентации проектов, результаты

Команды по очереди представляли результаты и рассказывали о планах на будущее.

В презентации команды «Документация» мы рассказали о проделанной работе: показали основную идею новой структуры сайта, рассказали о принципах изложения нового материала и поделились результатами опроса. Миша на практике показал новую идею quick start'а по БЭМ.

В результате хакатона мы успели сделать следующее:

  • определили направления развития сайта bem.info, идеей которого будет разделение методологической и платформенной частей и вынесение информации по каждой технологии в отдельные независимые разделы;
  • выработали основные принципы подачи материала. Данный набор принципов будет доступен на сайте после преобразования его структуры;
  • собрали фидбек и сделали выводы. Например, о том, что мы считали одной из основных проблем слишком большие и сложные документы. Оказалось, проблема не в этом. Опрос показал, что разработчики готовы читать объемные документы, если они хорошо структурированы и «приправлены» годными примерами;
  • начали работу над новым документом «Создание статической страницы на БЭМ», который должен стать быстрым и удобным quick start'ом для новичков. Документ в работе. Мы планируем опубликовать его в ближайшее время;
  • переведена следующая документация:

Когда презентации закончились, определились финалисты (да, дух соревнования присутствовал!) и, конечно, проект-победитель! Всем вручали призы (интересные книги от издательства «Манн, Иванов и Фербер» и футболки). Ну и, конечно, были совместные фото. Закончился хакатон веселым ужином и прогулкой по ночной Москве.

Выводы и впечатления

За хакатон наша команда не только успела сделать основные запланированные задачи, но и немного вышла за рамки планов. Два дня были продуктивными и насыщенными!

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

Впечатлений и вдохновения за эти два дня хватит надолго! Все происходящее за это время было наполнено совместной работой и эмоциями, общими стремлениями, командным духом! Что радовало и воодушевляло, так это то, что конкуренция была здоровой, чувство локтя подкреплялось обоюдной помощью и советами: ребята из разных команд советовались друг с другом и даже (это вообще было очень круто!) использовали только что созданные решения в своих проектах! Вот в этом и была та прелесть и душевность, которыми был пропитан процесс!

Спасибо всем и Stay BEMed!