Привет, Хабр!
Меня зовут Алексей, я работаю техническим писателем в ISPsystem. Недавно я впервые выступил спикером на крупной профильной конференции — Techwriter Days. Сегодня расскажу, зачем это сделал, как готовился и что нового узнал от других выступающих.
Я не техпис — я только учусь, или С головой в новую специальность
В профессию техписателя я попал пять лет назад. До этого 15 лет работал системным администратором в различных бюджетных организациях и однажды выгорел: надоела рутина и большое число задач, выполняемых для галочки. Стал искать работу, соответствующую моим скиллам в ИТ, и наткнулся на вакансию технического писателя в компании ISPsystem.
Уходить с насиженного места в неизвестность было страшно, но я сделал этот шаг и не пожалел. Работать техписателем мне понравилось: практически каждый день узнавал что-то новое. Писать тексты я любил, а то, что мои статьи помогают людям, мотивировало развиваться в профессии. Для этого пришлось освоить большой объем информации: от основ инфостиля до принципов микросервисной архитектуры.
Нужно больше идей
Когда я пришел в компанию, команда техписателей состояла из двух человек (сейчас уже в полтора раза больше). Мы варились в собственном соку, и нам порой не хватало свежих идей извне. Конечно, существовали чаты техписателей, где можно было задавать вопросы, но иногда мы просто писали в пустоту. Поэтому мне хотелось посетить профессиональную конференцию, вживую пообщаться с коллегами по цеху, обсудить проблемы и поделиться своим скромным опытом.
К сожалению, в последние годы конференций для техписателей в России не было: DocFactor больше не проводят, а Яндекс, собиравший «Гипербатон», сначала взял паузу на период пандемии ковида, а потом и вовсе пропал с радаров с этой активностью. В конце 2023 года я услышал про Techwriter Days. Ее организаторы уже проводили конференции для аналитиков и решили впервые выйти с аналогичным мероприятием на новую аудиторию — техписов. Я подумал, что нашей команде — мне и моей коллеге — было бы полезно в ней поучаствовать. После такого длительного перерыва у техписательского комьюнити наверняка накопилось много мыслей, которыми хотелось бы поделиться. Я согласовал с руководителем участие и начал подготовку к поездке в Москву, где происходило событие.
Слушать нельзя выступать!
Мне хотелось не только послушать доклады, но и выступить самому. Во-первых, для меня это был новый опыт (конечно, на предыдущих местах работы я несколько раз выступал на локальных конференциях, но по большей части это были формальные доклады о выполнении квартальных планов). Во-вторых, хотелось внести свой вклад в развитие комьюнити.
Чтобы найти тему, которая была бы интересна аудитории, я задал себе вопрос: а чем наша команда техписателей отличается от других? На первый взгляд, мы такие же, как большинство: используем Confluence и канбан-доски, пишем доку простым и понятным языком. Тогда я более детально изучил наши процессы и понял, что комьюнити могли бы быть интересны наши подходы к работе с обратной связью. Тем более что эта тема почему-то довольно редко затрагивается на конференциях и митапах.
Обратная связь для нас — штука важная, а получить ее зачастую проблематично. Когда у писателя нет возможности напрямую коммуницировать с читателем, ему приходится представлять абстрактный образ, придумывать этому образу имя, род занятий, цели — и на основании этих гипотез составлять документацию. Например: это Вася, системный администратор, 34 года, не боится сложных технических терминов, в документацию заходит, чтобы решить проблемы, связанные с продуктом.
Наша команда столкнулась с проблемой отсутствия обратной связи четыре года назад, когда из разных источников стала получать информацию о низком качестве нашей документации без какой-либо конкретики. Тогда мы ввели практику коммуницировать с нашими читателями: внедрили на портал с документацией форму обратной связи и стали проводить периодические опросы наших клиентов. Так мы получили достоверную информацию о том, кто наши клиенты и с какими проблемами они идут в документацию.
Этой информацией я и решил поделиться со слушателями. Я написал тезисы, подготовил презентацию и подал заявку на участие. Желающих выступить было много: на 49 мест подали около ста заявок. Моя тема оказалась актуальной, и оргкомитет включил меня в программу конференции, после чего назначил куратора, с которой мы «причесали» доклад. Коллеги тоже мне помогли с подготовкой: руководитель дал ценную обратную связь по содержанию доклада, а дизайнер навела красоту в презентации.
Разрешите доложить, или О чем вещали на Techwriter Days
Конференция проходила 5 и 6 апреля в отеле «Арт Москва». На мероприятие собралось около 400 человек. Те, кто не смог приехать, смотрели конференцию в онлайн-трансляции.
Программа была разбита на три секции: в двух проходили доклады, в третьей — мастер-классы. Это значит, вживую можно было послушать только треть выступлений — каждый раз приходилось выбирать. Но это было не очень критично: все доклады можно было посмотреть в записи на сайте конференции.
Всего было 49 докладов от технических писателей и других специалистов, занимающихся созданием документации. Темы достаточно разнообразные: от DocOps и искусственного интеллекта до UX-текстов и ГОСТов. Был даже круглый стол на тему «Как правильно писать слова типа „кэшбек“ и „бэкенд“».
Лично мне больше всего были интересны темы процессов и развития команды. Ниже — доклады, которые запомнились:
Евангелист техписательства Семен Факторович (documentat.io) озвучил результаты исследования рынка техписателей в России: чем занимается среднестатистический отечественный техпис, где живет и сколько зарабатывает (наконец-то увидел Семена вживую! до этого общались только онлайн).
Сергей Кулаков (Cloud.ru) рассказал, как составить карту компетенций технического писателя.
Дарья Цыган (Naumen) поделилась историей о сборе обратной связи от коллег и о продвижении команды.
Кроме докладов, был уголок баркемпинга, где мог выступить любой желающий. К сожалению, на него у меня времени не оставалось, хотя там тоже был интересный контент: спонтанные доклады, бизнес-игры и круглые столы. Надеюсь, мне удастся попасть туда в следующий раз.
Помимо этого, в кулуарах можно было пообщаться напрямую с докладчиками. Все эти активности были разбавлены кофе-брейками и фуршетом с шампанским и музыкой.
На мой взгляд, наиболее ценная часть на таких конференциях — это неформальное общение. Организаторы молодцы, жестко выдерживали тайминг, но из-за этого не все смогли задать свои вопросы докладчикам сразу после выступления. Зато после доклада возле выступавшего всегда стихийно собиралась мини-конференция, на которой можно было получить ответы на свои вопросы, а порой узнать подробности, не вошедшие в доклад.
Я выступил с блиц-докладом на 20 минут в основной программе конференции. Особых инсайдов там не было, но мне показалось важным проговорить ряд тезисов:
Если нет возможности получить обратную связь у заказчика напрямую, то форма обратной связи — рабочее решение.
Чем меньше кликов нужно сделать пользователю, чтобы оставить фидбек, тем больше объем фидбека. В одной из версий нашей формы обратной связи мы сильно усложнили дизайн и количество отзывов сразу упало в 5 раз.
Количество лайков и дизлайков, оставленных к статьям, вполне может использоваться в качестве KPI документации. Конечно, он будет сильно зависеть от настроения пользователей, но варианта лучше мы пока не придумали.
Собранный фидбек не должен лежать мертвым грузом: его надо анализировать и делать выводы. Мы стараемся регулярно актуализировать статьи, по которым собираем больше всего дизлайков.
У меня нет боязни сцены, но после публичных выступлений я обычно чувствую себя измотанным, приходится восстанавливаться коньяком. В этот раз после доклада был достаточно бодрым. Видимо, сказалась заинтересованность аудитории: они ставили лайки, задавали вопросы о том, как внедрить у себя подобные практики. Больше всего запомнился вопрос: «А нужно ли проводить опросы, если они просто подтверждают ваши гипотезы?». Такая формулировка может демотивировать, но важно понимать, что без опросов гипотеза так и останется гипотезой, а подтвержденная результатами опроса — станет фактом.
Что по трендам
Если суммировать содержание всех докладов, то я бы выделил следующие тенденции:
Поиск новых инструментов для создания документации. Большинство российских специалистов, как и наша команда, по-прежнему используют «буржуйский» Confluence, но постепенно появляются и отечественные альтернативы. Например, «Документерра» представила на конференции вариант единого портала для различных видов документации, а Gramax предложил решение, совмещающее подход Docs as Code и WYSIWYG-редактирование.
Использование искусственного интеллекта и машинного обучения. Эта тема была мне очень интересна: хотелось понимать, насколько широко ИИ используется при написании документации и как скоро он лишит меня работы. Прогноз благоприятный: в ближайшее время ChatGPT не заменит человека по причине своей непредсказуемости. Напротив, он скорее друг: может помочь справиться со страхом чистого листа и уже активно используется в поисковых движках на порталах с документацией.
Эволюция роли техписателей. Всё реже слышится фраза «Вашу документацию никто не читает». Бизнес осознал ценность качественной документации, а техписатели — свою важность для бизнеса. Пока слушал доклады на эту тему, примерял истории других компаний к нашей команде. Многие практики показались полезными: например, использование дайджестов для продвижения культуры документирования в компании или создание регламента, описывающего, чем занимаются техписы и как
их кормитьсоздавать для них задачи. Большинство сотрудников ISPsystem знают о нашем существовании, но периодически появляются вопросы типа «Ой, а что вам можно обратную связь по доке передавать?».
Выводы и инсайты
Свой первый опыт участия в такой крупной конференции считаю положительным. Я получил много интересной информации, которую уже можно применить на практике, поделился собственными мыслями и познакомился с кучей классных людей.
Самым сложным после конференции было структурировать всю полученную информацию — ее было нереально много. Но, поскольку это базовый скилл писателя, я справился. Помогли заметки, которые я делал во время докладов, и просмотр записей выступлений. Кратко поделюсь своими выводами:
В России довольно большое профессиональное комьюнити техписателей, оно расширяется и развивается. Увеличивается количество тематических ресурсов в Telegram. Самым популярным остается «желтый» чат, но и помимо него существуют десятки ресурсов (в моей папке «Техписовское» в Telegram уже около 20 чатов и каналов). Регулярно проводятся публичные митапы (например, Techdoc Meetup от X5 Tech). Это показывает, что роль документации в разработке продуктов растет.
Участвовать в конференциях полезно с точки зрения опыта: узнаешь много нового, знакомишься с другими писателями (вживую увидел коллег из «Группы Астра», с которыми до этого общался только через Zoom, а также техписателя наших партнеров — ISPmanager). Это помогает понять, что у всех примерно одни и те же боли: как оптимизировать свои процессы и объяснить коллегам, что ты не тестировщик, аналитик или копирайтер.
Если нет великих идей для доклада, можно поделиться даже простой историей — кому-то наверняка ваш опыт будет полезен.
Напоследок расскажу интересный факт с конференции. Среди партнеров мероприятия был Центр развития мозга, который предлагал всем участникам пройти тесты на концентрацию и расслабление. С первым успешно справились 90% тестируемых, а со вторым только 10%. Наверное, концентрация на работе и неумение релаксировать — это профессиональная черта технических писателей, а возможно, и большинства современных людей. Так что желаю всем научиться расслабляться в этой нелегкой жизни!
Большое спасибо:
компании ISPsystem за то, что сделала возможным участие нашей команды в конференции;
организаторам конференции и отдельно — куратору моего доклада Анастасии Московкиной;
всем участникам, которые поделились своими знаниями.
P.S. Уже жду Techwriter Days 2 в следующем году!
