Как стать техническим писателем: мнение эксперта
По данным zarplan.com, средняя зарплата технических писателей в октябре 2022 года — около 100 000 рублей. Неудивительно, почему все больше людей собирается освоить эту специальность.
Действующие лица
Команда Документерры решила разобраться, как студенты учатся работать с документацией. Об этом нам рассказал Игорь Олегович Ситников — кандидат технических наук, преподаватель курса по технической документации в Уральском федеральном университете (УрФУ).
Технический писатель — кто это?
Технический писатель — это специалист, который помогает пользователям разобраться в сложном технологическом продукте. Только делает он это при помощи контента, а не через общение с клиентами, как техподдержка.
Допустим, ваша компания производит стиральные машины. Чтобы покупатели быстрее разобрались с функциями нового устройства, нужна инструкция. При помощи документации клиенты узнают, как правильно выбрать режим стирки, какие неисправности у устройства могут появиться и не только.
Технические писатели также готовят внутреннюю документацию для компаний. В этом случае инструкциями пользуются уже сотрудники. Например, стажеры могут быстрее вникнуть в рабочие процессы благодаря полезным статьям из базы знаний. Иначе новичкам пришлось бы каждый раз задавать вопросы опытным коллегам, что отнимало бы у всех много времени.
Как долго учиться на технического писателя?
В университетах на профессию «технический писатель» не учат, есть только курсы. У них разная продолжительность: от пары дней до нескольких месяцев. Например, Игорь Олегович как раз ведет курс для студентов УрФУ.
Я веду курс «Современные технологии разработки технической документации» с 2017 года. Мои студенты — магистранты УрФУ. Они не учатся именно на технических писателей: их специальность гораздо шире. Но работа с документацией — важная компетенция для них.
Мой курс длится 36 часов. Четверть из них занимают лекции, а остальную часть — лабораторные работы. На все уходит чуть больше двух месяцев.
Еще все зависит от области, в которой будет работать технический писатель. Например, специалист собирается создавать документацию для химического предприятия — там техническому писателю будет сложно без химического образования. В этом случае обучение будет длиться минимум четыре года в университете, если не считать времени, которое уйдёт на изучение основ технического писательства.
Не представляю, как можно готовить технического писателя без наличия у него подготовки в конкретной прикладной области. Это тогда уже специалисты, которые близки к полиграфии — вроде технических редакторов.
Что должен уметь технический писатель?
Во-первых, профессиональный технический писатель хорошо знает русский и английский языки. Во-вторых, он умеет структурировать информацию так, чтобы читателю было легко читать инструкции. В-третьих, специалист владеет профессиональным инструментом — таким, как Документерра.
Мои студенты проходят практическую часть курса на Документерре. Там они учатся:
1) создавать проекты,
2) импортировать документы из различных форматов,
3) редактировать страницы,
4) применять технологию единого источника,
5) экспортировать проект в финальные форматы.
Игорь Олегович уделяет особое внимание технологии единого источника, которая позволяет использовать один фрагмент контента сразу в нескольких местах.
Представьте ситуацию, когда в конце каждой страницы инструкции нужно указать актуальную версию ПО. В этом случае технический писатель может создать общую переменную и использовать ее на каждой странице. Без технологии единого источника специалисту пришлось бы обновлять всю документацию вручную при выходе обновления ПО и изменении номера версии.
В итоге техническому писателю необходим профессиональный инструмент для того, чтобы:
- Эффективнее работать с документацией. Например, шаблоны и готовые блоки контента позволяют создавать проекты за пару кликов. А глобальные поиск и замена, технология единого источника и другие функции — быстрее обновлять документацию.
- Настраивать доступ к публикациям. Некоторые компании против того, чтобы их документация была в открытом доступе. В этом случае нужно выбрать программу, которая позволит защитить публикации паролем.
- Комфортно работать в команде с коллегами. Например, Документерра позволяет оставлять на странице ревью комментарии и списки задач, чтобы авторам было легко вносить правки. Еще можно увидеть историю изменений каждой страницы, что помогает техническому писателю быстро восстановить содержимое, если другой автор случайно удалит какой-нибудь важный фрагмент.
Документерра как инструмент для обучения технических писателей
Документерра — российская разработка, поэтому мы предоставляем бесплатную лицензию для УрФУ. Мы понимаем, насколько важна практика для начинающих технических писателей, которые потом будут работать в России.
Если вашему вузу тоже нужна бесплатная лицензия Документерры для обучения студентов, свяжитесь с нами по адресу sales@documenterra.ru — мы с радостью поможем!
Вот почему Документерра идеально подходит для обучения студентов:
- Платформа работает онлайн. Чтобы начать использовать Документерру, нужно только открыть браузер. То есть если студенту придется работать с другого компьютера, не нужно будет что-то переустанавливать.
- Преподавателю легко отслеживать прогресс каждого ученика. Поскольку студенты работают на одном портале, учитель может заметить, что у кого-то не получается выполнить задание, и быстро прийти на помощь.
- Студенты осваивают профессиональные подходы к документации. Ученики не просто пишут технические тексты, но и учатся работать в команде, создавать динамический контент, а также настраивать доступ к документации.
Какие перспективы у профессии «технический писатель»?
Искусственный интеллект на наших глазах учится рисовать картины все лучше — например, нейросеть Midjourney прекрасно генерирует изображения на основе текста. В связи с этим художники со всего мира беспокоятся о том, что их профессия может стать ненужной в скором будущем.
Появляется закономерный вопрос: а что ждёт IT-область в общем и технических писателей частности? Кажется, что генерировать текст не сложнее, чем изображения. Насчёт этого мы спросили нашего эксперта.
IT продолжит определять развитие всех технологий в будущем. В этом случае роль технических писателей станет зависеть от того, при помощи каких технологий пользователи будут получать контент.
По-моему, искусственный интеллект не заменит труд технических писателей, пока человек остается источником потребности в новом ПО и генератором идей по реализации такой потребности.
Заключение
Мы поговорили с Игорем Олеговичем об обучении технических писателей и поняли следующее:
- Знать основы технического писательства недостаточно для работы. Необходимо также хорошо разбираться в прикладной области — например, в химии или медицине.
- В университетах не учат на специальность «технический писатель», нужно проходить курсы. Их продолжительность — от пары дней до нескольких месяцев. Мы как раз недавно делали обзор курсов для техписов, рекомендуем почитать: «ТОП‑6 курсов для технических писателей».
- Чтобы работать с документацией профессионально, необходимо использовать такие функции, как технология единого источника, создание динамического контента, экспорт и импорт проектов в различные форматы и не только. Все это можно сделать в Документерре.
- Поскольку людям еще долго будет нужна документация, можно смело осваивать эту специальность.
Игорь Олегович и его студенты способствуют развитию профессии «технический писатель» в России. Мы очень рады помогать им, предоставляя бесплатную лицензию Документерры, ведь для начинающих специалистов важен опыт работы с профессиональным инструментом.
Мы желаем Игорю Олеговичу успехов в преподавании, а нашим читателям — в освоении профессии «технический писатель».