Обложка: Почему обучение технического писателя — это нетривиальная задача

Почему обучение технического писателя — это нетривиальная задача

Рассказывают технические писатели IT-компании Lad Екатерина Каляева, Анна Назолина, Ксения Скорынина.

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

В этой статье мы расскажем о путях развития технического писателя, а также о собственном опыте обучения техрайтеров внутри компании и вне её.

Образование и скиллы

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

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

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

  • сильные навыки коммуникации;
  • умение быстро разбираться в сложных технологиях и концепциях;
  • hard skills по работе с техническими текстами.

Схема базовых навыков технического писателя

Таким образом, технический писатель — это мост между разными аудиториями. Он умеет найти подход к людям с разными темпераментами, обладает большим объёмом «оперативной памяти», умеет вычленять из потока информации главное и ставить вопросы, чтобы закрыть пробелы в знаниях. Благодаря этим качествам технический писатель может глубоко понять цели технического текста и сделать его корректным, полным и эффективным.

На минимальных требованиях, конечно, никто не останавливается, поэтому и мы добавим к ним несколько hard skills.

  1. Опыт работы с общими для IT корпоративными инструментами (Jira, YouTrack, Slack, Gitlab).
  2. Навыки работы с инструментами, позволяющими строить схемы, диаграммы (например, diagram.net, Lucidchart).

Поскольку технический писатель — профессия на стыке гуманитарного и технического, пригодятся базовые навыки из профессиональных областей коллег:

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

Схема hard skills технического писателя

Почему обучение техписателя — это непросто

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

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

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

Однако, даже зная, где искать материалы для обучения, важно выбирать только релевантное и отсеивать ненужное. Почему сложно подобрать курс по документированию? Многие существующие на рынке варианты работают как введение в профессию или фокусируются на разработке документации по ГОСТ. Действительно стоящие и крутые курсы плохо гуглятся: их анонсируют в тех же telegram-каналах.

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

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

  • Ю.В. Кагарлицкий. Разработка документации пользователя программного продукта. Методика и стиль изложения.

Базовая книга о пользовательской документации, которая может неплохо систематизировать имеющиеся знания.

  • Нора Галь. Слово живое и мертвое.

Классика антиканцелярита. Это та книга, которая будет полезна всем пишущим независимо от целей их текстов.

  • Александр Орлов. Джедайские техники конструктивного общения.

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

Подборка книг для технических писателей

Как же учиться техническому писателю?

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

  1. Найти единомышленников. Пусть это будут не техписатели, а аналитики, project- и product-менеджеры, QA-инженеры. Важно чувствовать, что ты можешь обсудить свои профессиональные вопросы с кем-то и получить поддержку и тезисы для размышлений. Например, мы организовали сотрудничество с гильдией аналитиков. Встречаемся раз в месяц и обсуждаем общие темы, из последнего: как готовить схемы в разных нотациях.
  2. Если не удаётся найти коллег по цеху внутри компании, можно поискать вовне. Например, есть русскоязычный чат в Telegram, где состоит около двух тысяч человек, так или иначе связанных с техписательством. Другой вариант: англоязычный Slack техрайтеров со всего мира writethedocs.slack.com. В них можно найти анонсы профессиональных мероприятий, задать вопрос по рабочим процессам и инструментам, найти ментора, если нужна консультация или обучение 1 на 1.
  3. Пользоваться проверенными агрегаторами курсов (Coursera, Stepic, HiBrain). Они не делают громких обещаний о моментальных успехах, но имеют подтверждённый отзывами участников профит и развитие в профессии или смежных сферах.
  4. Вести «дневник побед». Звучит забавно, но мотивирует продолжать развитие, даже если пока не с кем этим поделиться. Работать с ним просто: каждый день выделяйте 5 минут ближе к концу рабочего дня, чтобы вспомнить и записать, какие челленджи вы сегодня решили или к каким большим и долгосрочным задачам подступили. Фокус должен быть на новых для вас подходах и методах, а также на результатах, которые имеют реальный профит для вашей компании, людей и процессов в ней.

Схема обучения технического писателя

Что в итоге?

В настоящее время работа техническим писателем привлекает много внимания. С каждым годом должность становится более актуальной и востребованной (среди молодого поколения). Однако обучение профессии не является простым линейным и требует дополнительных усилий в подборе подходящих источников для обучения и развития навыков.

Зная, какие soft- и hard-скиллы необходимы в работе технического писателя, а также обладая упорством и пониманием того, где искать проверенные материалы, можно максимально усовершенствовать свои профессиональные навыки и стать незаменимым сотрудником компании.

Хинт для программистов: если зарегистрируетесь на соревнования Huawei Cup, то бесплатно получите доступ к онлайн-школе для участников. Можно прокачаться по разным навыкам и выиграть призы в самом соревновании.

Перейти к регистрации