Всем привет! Меня зовут Катя, я развиваю Gramax — базу знаний для ИТ-команд. Эта статья — интервью с Екатериной Ушаковой о ее книге «Если ты — технический писатель». Екатерина Ушакова — одна из узнаваемых фигур в сообществе технических писателей. Она создала техническую редакцию в Ozon, преподает в Университете Иннополис, организует конференции и ведет сообщество руководителей технических редакций.
Сейчас Катя готовится к выпуску книги о современном техническом писательстве. В статье вы узнаете:
Как и зачем Катя решила написать книгу о роли «Технический писатель».
Почему выбрала печатный, а не электронный формат.
Как Gramax помог справиться с редактурой сотен комментариев.
Это интервью, как и сама книга, будут полезны не только техническим писателям, но и тем, кто сталкивается с документацией в своей работе: аналитикам, менеджерам, копирайтерам и другим техническим коммуникаторам.
Для тех, кто еще не знаком с твоей работой в техписательском сообществе — кто ты и чем занимаешься?
В техническом писательстве я уже восемь лет. Начинала с Академии Гипербатона — прекрасного проекта от Яндекса. Какое-то время работала в Яндексе, потом перешла в Ozon, где создала техническую редакцию по новому формату продуктовых технических писателей. У нас был один централизованный отдел, который обеспечивал текстами весь Ozon — от пользовательских инструкций и подсказок в интерфейсах до внутренних регламентов и суперсложных технических документов.
В Ozon я начала активно продвигать эту парадигму через митапы Techdoc Meetup, которые мы делали совместно с Настей Московкиной из X5. Сейчас ни я в Ozon больше не работаю, ни Настя в X5, но дело живет — митапы продолжаются. Помимо этого, я участвую в организации конференции Write Conf под брендом Стачки. Мне важно, чтобы на этой конференции были не только технические писатели. Потому что роль часто размыта, и то, что мы понимаем под техническим писателем, не всегда совпадает с представлениями в других компаниях.
Еще я преподаю в Университете Иннополис курс по техническим коммуникациям. Мне важно воспитывать в новом поколении ИТ-специалистов понимание, что техническое писательство — это отдельная роль. После каждого семестра студенты устраиваются на работу в Ozon, Яндекс и другие компании.
Также у меня есть канал в Telegram «Ушакова — директор Буковок» и сообщество руководителей технических редакций. Это закрытое комьюнити примерно на тридцать человек — руководителей из разных компаний. Мы раз в месяц созваниваемся и видимся в Москве очно, делимся опытом, помогаем друг другу с наймом и вакансиями, обсуждаем, как устроены процессы в наших компаниях. Если хотите к нам — напишите!
Насколько знаю, ты еще и ментор. Это тоже важная часть твоей деятельности?
Да, когда я работала в найме, ко мне периодически обращались люди за консультациями, но сложно было уделить этому достаточно времени. Один из аргументов в принятии решения о выходе из найма было именно менторство. Мне было обидно, что ко мне обращаются люди, мне интересно рассматривать их кейсы, но я не могу уделить им достаточно времени.
Сейчас я занимаюсь двумя направлениями. Первое — наставничество технических писателей и смежных ролей, которые занимаются документацией. Это не репетиторство, а скорее менторство в профессии. Мы сразу договариваемся на несколько созвонов, прорабатываем план, я даю домашние задания и материалы. Цель — помочь человеку раскрыть свои навыки, понять, куда развиваться дальше внутри компании или как соответствовать требованиям желаемой компании.
Второе направление — консультации компаний. Это может быть аудит существующей документации, выстраивание процессов работы технических писателей, найм новых сотрудников, создание матриц компетенций. Работая с компаниями, я вижу реальное состояние технического писательства на рынке — как компании относятся к техписам, что им действительно нужно. Сейчас у меня есть возможность разбираться в разных кейсах и помогать компаниям выстраивать лучшие технические коммуникации.
Как ты пришла к тому, что нужно написать книгу?
Пока я готовилась к университетскому курсу и развивала технических писателей в своей команде, мне нужно было рекомендовать им материалы. В университете проблем с англоязычными материалами нет, потому что в Иннополисе все обучение на английском языке. Но своим сотрудникам давать книги на английском не всегда вариант — язык становится преградой.
На русском языке материалов немного. Да, они есть, в целом неплохие, но специфичные. Я создавала редакцию по новому продуктовому фреймворку, новому витку профессии. И для него пока нет литературы на русском языке, которую можно было бы в первый день вручить сотруднику и сказать: «Давай, осваивай, прочитаешь — будем тебя повышать».
Остро ощущалась нехватка материалов. Часто человек в принципе не знает, что такое техническое писательство, что такое техническая документация, как работать в команде. Может быть, что-то слышал про ГОСТы, но ГОСТы мы не пишем. Очень хотелось дать структурированные материалы. Так появился курс в Иннополисе, и так появилась идея написать методичку к этому курсу, чтобы можно было выдавать в первый рабочий день.
Получается, эта книга для начинающих технических писателей? Или уже работающие специалисты тоже найдут для себя что-то полезное?
Под технической документацией я склонна понимать любые коммуникации между участниками процесса разработки или поставки программного обеспечения. Глобально аудитория делится на пользователей и разработчиков — тех, кто добавляет продукту ценности с помощью документации, и тех, кто пользуется продуктом, решает свои задачи. Это может быть документация API или внутренних продуктов для разработчиков, руководства пользователя, администратора. Это любой формат, который поможет достичь цели. Потому аудитория книги делится на 3 части:
Новички-техписы. Люди, которые впервые столкнулись с профессией. Либо они нашли свою первую работу и им вручают эту книгу, либо они читают ее и находят свою первую работу.
Уверенные техписы. Вся книга построена по процессу работы технического писателя — что он должен делать, чтобы написать и подготовить документацию. Но она может быть полезна и уже работающим специалистам. Например, чтобы заполнить пробелы — обратить внимание, какие метрики в документации я выделяю. Это всегда больная тема, и у меня есть глава, посвященная этому. Может быть это поможет вдохновиться примерами и разработать свою систему.
Другие специалисты, работающие с документацией. Важно понимать, что технический писатель — это не всегда профессия, это иногда роль. Есть компании, где даже при наличии отдела технической документации все равно есть люди, которые пишут документацию, но они не технические писатели по должности. Для них книга тоже будет полезна.
Можешь рассказать, из каких блоков состоит книга? Какие темы ты затрагиваешь?
Глобально в книге можно выделить три раздела. Первый — понимание проблемы, которая возникла из-за недостатка информации. Второй — добыча этой информации. Третий — укладывание информации в нужный читателю вид.
Я отталкивалась от процесса работы технического писателя, чтобы книга могла стать гайдом. Технический писатель получает задачу, открывает книгу и понимает: первое, что нужно сделать — понять целевую аудиторию. Для кого я вообще пишу? Потом надо понять, с какими проблемами эта аудитория сталкивается. Часто задача вроде «допиши вот это» не решает проблему, а выступает примером решения, которое не всегда правильное. Я призываю технического писателя самому пойти подумать, поисследовать, поговорить с продактами, авторами задачи, понять, с какими реальными проблемами сталкивается наш читатель. Может быть, ему не документация нужна, а более понятный интерфейс или другой продукт.
Второй блок — сбор и обработка информации. Здесь говорим о том, какие источники у нас есть, какие методы сбора информации, как выстраивать коммуникации с держателями знаний, кто вообще такие держатели знаний. Немножко говорим про инструменты совместной работы с информацией — мозговые штурмы, исследования. Все то, что поможет собрать информацию, чтобы устранить проблему, которую мы выяснили на первом шаге.
Треть книги — работа с самим текстом. Здесь я транслирую свое видение, что технический писатель — это больше, чем «поправь вот это», это дизайнер коммуникаций. Затрагиваю темы атрибутов текста, что такое стайлгайд, глоссарий. Говорим про этапы работы — какие статусы задача проходит, пока техпис над ней работает. Бриф, написание черновика, вычитки, правки, снова вычитки и только потом публикация.
Также затрагиваются и другие темы. Например, метрики — базовые, очень базовые, поскольку книга для новичков. Просмотры, CSI, базовая оценка — была ли статья полезной или бесполезной. Все то, что можно увидеть в базовых настройках Яндекс.Метрики. Ничего сверхсложного, никаких комплексных метрик или индексов. И как это можно связать с метриками продукта.
Еще говорю про работу в команде технических писателей — какие бывают команды, распределенные или централизованные. Немножко про уровни должностей. Поскольку это книга для младшего, ему нужно сформировать видение, куда дальше развиваться. Чуть-чуть затрагиваем тему сообщества — зачем оно нужно, почему участвовать в жизни сообщества полезно и классно.
Книга — это не просто поток моих мыслей. Это как минимум семнадцать книг, которые я изучала по теме, которые я переиспользовала и упоминала как источники информации. А также реальные кейсы из разных компаний, в которых я участвовала сама или наблюдала у коллег.
Почему ты решила делать именно печатную книгу?
Я считаю, что технические писатели немножко ретрограды в том плане, что очень любят всякие блокнотики, ручки, канцелярию. Я сама с двумя блокнотами сижу, несмотря на то, что мне муж купил iPad, чтобы я перестала плодить блокноты дома. У меня стеллаж с книгами, и в него уже ничего не влезает, на столе со всех сторон книжки лежат. Просто я люблю пощупать.
У нас в Ozon был экземпляр Мильчина, который переходил от руководителя к руководителю. Он мне достался по наследству, сейчас пошел дальше. Он физический, бумажный, есть в офисе.
В век цифровизации информации мне иногда не хватает ощущения физического. Может быть, поэтому я завела кота — чтобы найти физически мягкое, а не смотреть на видео с котиками в интернете. С книгой то же самое. Хочу, чтобы писатели могли открыть мою книгу, полистать, использовать ее в обсуждениях.
Пока я не уверена, будет ли электронный формат — есть аргументы и за, и против.
Расскажи про инструменты написания книги. Мы знаем, что некоторую часть работы ты провела именно в Gramax. Как это было?
Начала я в Google Docs. Я не уверена, что выбрала бы что-то другое на старте — это довольно простой инструмент, особенно для самостоятельной работы. Написал, отправил ссылку на вычитку — не возникает барьеров, чтобы эту ссылку открыть.
Я отдавала книгу на вычитку бета-ридерам в Google Docs в режиме комментирования. У каждого бета-ридера был свой экземпляр. В момент, когда у меня случилось копий, наверное, семь — оригинальная рукопись, версии с комментариями от бета-ридеров, черновая рукопись — я перестала работать над книгой. Потому что сложить это все в один Google Docs практически нереально. Такая стена для прокрастинации, это отвратительно.
Тогда я решила, что нужно, во-первых, подумать над инструментом, во-вторых, нанять человека, который сделает это все за меня. Спасибо Полине большое, что она это доделала! С редактором мы стали думать, в каком редакторе нам работать. Поскольку и я, и моя редактор — адепты Docs as Code, мы подумали, что было бы неплохо каждый из этих вариантов книги просто выделить в отдельную ветку.
Но заморачиваться с разворачиванием Git, настройкой доступов, всеми техническими штуками вроде merge request, комментариями — мы не захотели. Тут я вспомнила о существовании Gramax. И я говорю: «Полин, давай попробуем Gramax». Классный инструмент, с визуальным редактором, под капотом те же ветки. Мы спокойно сможем сделать под каждый экземпляр ветку.
Мы каждую версию просто скопировали и вставили в отдельную ветку. Комментарии нам пришлось сверять, но этим занялась редактор. У нее был открыт Google Docs, и она обрабатывала комментарии уже в Gramax, сохраняла у себя.
Я видела эти ветки, я могла в каждую из них зайти. Я видела, сколько комментариев она мне там оставила, и просто отвечала уже в Gramax. В итоге все это просто сливали в мастер-ветку, в финальную версию.
На самом деле у нас в книге при описании работы с Git был один из комментариев, что непонятно, как в Git работать. И мы решили это объяснить на своем примере: представьте, что вы делаете книгу в Git. Прямо рекурсия такая пошла!
Мы очень классно три месяца работали в Gramax со всеми этими ветками. Точно ничего не потеряли по дороге, точно обработали все комментарии, все это слили в финальный вариант, в котором точно все есть.
Где заканчивается технический и начинается просто писатель? Как бы ты описала схожесть и отличие этих двух профессий?
Писатель-то я не настоящий. В том плане, что в наше время выпустить книгу — это уже не так сложно, имелось бы достаточное количество экспертизы и денег на публикацию. Есть кейсы, когда ты просто отдаешь кучу денег и сырую рукопись, они за тебя ее дописывают, переваривают, полностью занимаются раскруткой, публикацией. Ты приходишь как эксперт, и дальше заботы издательства за твои деньги тебя раскрутить. Я пошла более сложным и длинным путем.
Отвечая на твой вопрос: в книге я говорю о том, что нужно исследовать целевую аудиторию, понять проблему, собрать информацию и переложить эту информацию в нужный формат. Собственно, я то же самое и сделала.
Это похоже на работу технического писателя на всех этапах.
Нашу «техничность» определяет то, что мы пишем в ИТ-сфере или в промышленности, но это не избавляет нас от того, что мы писатели. Потому что работа над любой коммуникацией требует одних и тех же этапов — исследование, сбор информации, написание, редактура, работа с обратной связью, публикация.
Что ты порекомендуешь новичкам в профессии?
Простой совет начинающим — начните. Я надеюсь, что начинающий, получив эту книжку любым способом, прочитает ее и поймет: в целом я все это знал, теперь у меня это сложилось в одну картинку, и я готов приступать к работе.
Когда ко мне на собеседование приходят люди, я всегда спрашиваю, насколько активен человек в сообществе. Не чтобы сказать: «Ты не пишешь в желтом чате, какой ты после этого техпис?», а с точки зрения того, как человек следит за тем, что происходит, насколько держит руку на пульсе. Даже если человек ответит, что он никого не знает, ни на какие конференции не ходит — это не делает его плохим кандидатом.
Я хочу, чтобы в какой-то момент в резюме, кроме «Пиши, сокращай» и желтой книжки, у людей начала появляться эта книга. И для работодателя это было бы сигналом, что человек знает, куда он идет, знает, как выглядит работа технического писателя.
Часто чьи-то достижения выглядят чем-то большим и недостижимым. Но другой человек УЖЕ проделал какой-то путь, который ты как начинающий — еще нет. Твоя задача — просто начать этому пути следовать.
Про дальнейшие планы. Что будет с книгой после выхода первого тиража?
Книга называется «Если ты — технический писатель». Пока я ее писала и сейчас, пока финально редактировала, я прямо по рукам себя била, чтобы не углубляться в темы. Новичку не надо знать какие-то сложные комплексные метрики, которые высчитываются из пяти параметров и влияют на бизнес. А вот старшему техническому писателю или руководителю это, возможно, будет полезно.
Я думаю, что в этом году немного приторможу. Мне надо все-таки отметить два года работы над книгой, выдохнуть, пересобраться. Но у меня уже есть задумки на продолжение — «Если ты — руководитель технических писателей», «Если ты — старший технический писатель». В целом даже есть некоторое понимание концептов этих книг.
Мне важны отзывы о книге. Я выпустила ее не чтобы потешить свое эго. Приятно, конечно, но мне хочется внести реальный вклад в профессию. И поэтому мне важно, чтобы книга отвечала потребностям профессии. А кто, как не представители профессии, мне об этом могут рассказать? 2026 год останется для сбора обратной связи и, возможно, для каких-то переизданий. А дальше я хочу сделать что-то похожее, чтобы раскрыть глубже некоторые темы.
Следующие книги планирую готовить под лозунгом: «вам надо об этом знать, но вам не надо в этом разбираться».
Книга «Если ты — технический писатель» выходит в марте 2026 года. Следите за анонсами в канале Кати Ушаковой «Ушакова — директор Буковок» в Telegram.
Узнать подробнее о Gramax — https://gram.ax/ru.
