Пока мы работаем над дневником разработчиков топливного плагина, появление которого вы одобрили большинством голосов (43 за, 5 против, 19 воздержались), предлагаем вам прочитать рассказ нашего технического писателя Ирины Поволоцкой о недавно прошедшем Гипербатонская конференция.
Это собрание техников, где они проводят свои тайные ритуалы (зачеркнуто) – делятся друг с другом своим опытом.
Поскольку каждый участник OpenStack должен уметь не только писать код, но и объяснять сообществу, почему этот код имеет право на существование, мы не могли оставить без внимания столь знаковое событие.
И вообще, у нас давно не было обновлений.
Вам вдруг стало скучно? 18 апреля, в субботу, состоялся третий «Гипербатон» — конференция, организованная Яндексом для технических писателей и всех, кто участвует в процессе создания документации.
«Гипербатон» проходил в офисе Яндекса в Москве.
У входа в конференц-зал всех встречал игрушечный Мастер Йода.
Для справки : название конференции выбрано не случайно: дело в том, что мода е рбатон (не гипербат О n, как может показаться на первый взгляд) — фигура речи, в которой слова совершенно магическим образом меняют привычный порядок, любимый приём главы Ордена джедаев.
Почему это важно для нас?
При работе с открытым исходным кодом в целом умение описывать движение программирования дает серьезные преимущества.Например, одобрение от команды, отвечающей за интеграцию партнерских технологий (а также преимущества в карме и оценке кода), получают те, кто умеет четко описать свои действия.
Если говорить конкретно об OpenStack, то для участия в сообществе разработчиков требуется не только умение писать код. Успех инициативы имеет огромное влияние умение логически и кратко описывать то, чем занимаешься, и обосновывать необходимость своей работы .
Вернемся к Гипербатону.
Как это часто бывает, особенно отличились организаторы.
Коллеги из Яндекса представили отличную подборку презентаций (их можно просмотреть Здесь ), посвященный различным аспектам творчества технических писателей.
Что вы хотите сказать?
Светлана Каюшина рассказал об увлекательном опыте, я бы даже сказал об эволюции технических писателей в Яндексе в зависимости от изменения количества членов команды — как происходил обмен опытом, обсуждения, технические дискуссии, отслеживание задач.Алексей Замулла поделился собственными впечатлениями от наставничества: как оказалось, наставничество приносит пользу и тренеру, и стажеру.
Вероятность получить отличную обратную связь и научиться управлять своим временем и задачами значительно возросла.
Дарья Еремина затронул тему погружения в Большой Проект, в котором, на первый взгляд, очень легко утонуть.
Действительно, проблема, знакомая любому техническому писателю, активно работающему в сообществе OpenStack, - количество мессенджеров, баг-трекеров, бэклогов просто зашкаливает и все это, конечно, нужно контролировать и делать качественно: создавая понятную документацию без фактических ошибок.
Дарья представила проблему как работу с различными потоками: потоком людей, задач, информации, времени и, конечно же, внимательностью.
Дарья точно заметила, что наши задачи иногда похожи на обезьянью работу, но именно внимание к деталям делает документацию точной.
Максим Ильяхов из ОКБ Артема Горбунова фактически провел мастер-класс, показав легким движением руки, как сделать текст легким, читабельным и понятным для пользователя.
Что особенно приятно, он представил ресурс для проверки текста на наличие «словесного мусора» — ненужных слов и фраз, которые можно легко выкинуть, не потеряв смысла.
Самые внимательные нашли ошибки в презентации и получили забавную наклейку с черепом и замечательный редакционный слоган.
Узнайте, чего вы хотели?
Технические писатели задавали много актуальных вопросов: как писать для специалистов, использовать ли профессиональный сленг; как мотивировать технических писателей к наставничеству и можно ли обучать не только новичков, но и друг друга; сможет ли технический писатель найти критические ошибки и заслужить уважение разработчиков — это лишь общие контуры дискуссии.Все это вполне знакомо каждому, кто вносит посильный вклад в сообщество OpenStack, или занимается решением конкретных задач, как в нашем случае (Fuel и Mirantis OpenStack).
Как это работает в Мирантисе Технические писатели в нашей компании работают в режиме многозадачности, стараясь следить одним глазом за апстримом, а другим за локальными проблемами, будь то обновление документации для нового релиза или исправление ошибок.
Однако нельзя забывать об отличительной особенности «Мирантис» — открытости наших путеводителей для всех: любой может внести изменения и попросить нас прокомментировать изложенное, предложить лучший вариант или формулировку.
Поэтому вопросы наставничества имеют для нас большое значение.
Конференция позволила мне пересмотреть подходы к решению наших проблем с открытым исходным кодом и задуматься о создании дополнительных инструментов (таких как руководство по стилю), улучшении уже существующих, а также, возможно, о том, чтобы сделать их более понятными и понятными.
прозрачный процесс внесения вклада в документацию .
Спасибо Яндексу за прекрасную возможность посмотреть на эффективность нашей работы со стороны.
Да пребудет со всеми нами сила.
слов! Если у вас возникли проблемы с описанием вашей работы с OpenStack, поделитесь с нами своими трудностями в комментариях.
А анализу типичных трудностей и описанию способов их преодоления мы будем рады посвятить отдельный пост. И может быть, как бы там ни было, мы сможем улучшить процессы внутри экосистемы, сформулировав предложения, которые коллеги смогут обсудить с руководством OpenStack Foundation на саммите в Ванкувере.
Теги: #Мирантис #Мирантис #openstack #Топливо #Гипербатон #Яндекс #открытый код
-
Вьетнамский Язык
19 Oct, 24 -
Не Называй Себя Вествудом!
19 Oct, 24
