Чтобы стать техническим писателем, вам необходимо развить 5 основных навыков и получить опыт работы

По данным zarplan.com, средняя зарплата технических писателей в октябре 2022 года — около 100 000 рублей. Неудивительно, почему все больше людей собирается освоить эту специальность.

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

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

Технический писатель — это специалист, составляющий документации в рамках разработки различных программ и автоматизированных систем, проведения НИОКР (Научно-исследовательских и опытно-конструкторских работ), а также решения иных технических задач.

Технический писатель может работать в двух направлениях:

• Клиенту от разработчика. В этом случае специалист изучает существующее ПО, а затем, «переводит» информацию таким образом, чтобы она стала доступной для конечного пользователя.
• Разработчику от клиента. В этой ситуации технический писатель вместе с бизнес-аналитиком оценивает потребности клиента, а затем приводит информацию к виду спецификации или технического задания.

Академия АйТи приглашает на курс, обучающий всем тонкостям работы технического писателя.

На курсе вы научитесь:

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

Программа стартует в Москве 30 мая!

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

Прекрасно и то, что в курсе есть блок практики, это очень помогает закрепить материал. Еще понравилось, что внутри блока есть курс лидерства и блок с HR.

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

Курс «Проджект-менеджер в IT»

До курса мои знания о тестировании основывались только на информации, которую я почерпнула из книг и бесплатных курсов. Оказалось, что тестирование – это не просто «нажать кнопочку и получить результат». Это очень сложный и безумно интересный процесс, включающий в себя работу с внутренней составляющей программного обеспечения.

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

Благодаря знаниям, полученным на курсе, я устроилась на работу в Axbit Group, чему очень рада! Это прекрасная возможность применить на практике полученные в ходе обучения знания, а также развиваться и расти в профессиональном плане!

Мне очень понравился формат обучения – очные занятия, возможность общения как с коллегами-студентами, так и с преподавателями. За время курса было много непонятных и трудных моментов, но все преподаватели сразу дали понять, что задавать вопросы не просто можно, а нужно! Даже во время выполнения домашних заданий преподаватели отвечали на возникающие вопросы, что было очень приятно.

В начале обучения было очень много вопросов и ощущение, что картина в целом совсем не складывается. Но чем больше я узнавала в процессе обучения и находила ответы на все эти вопросы, тем лучше понимала, что выбранная структура проведения занятий подходит идеально. Поэтому я могу только поблагодарить Axbit Academy и команду преподавателей за прекрасное обучение!

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Что в итоге?

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

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

Как стать техническим писателем «с нуля» [5 базовых навыков + 5 курсов]

Технический писатель — специалист, который занимается разработкой документов по заданию заказчика. В данном направлении авторы неплохо зарабатывают. По информации Нетологии, им платят в 1,8 раз больше, чем копирайтерам, которые создают преимущественно рекламный контент. Хотите освоить престижную профессию? В статье вы узнаете о том, как стать техническим писателем с нуля.

Коротко о профессии

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

Основные задачи специалистов сводятся к двум моментам:

• Сбор информации, ее компоновка и структурное изложение «на бумаге» по стандарту или шаблону.
• Отслеживание актуальности текстов в библиотеке компании и внесение в них корректировок при необходимости.

Профессионалы очень востребованы в сфере разработки программного обеспечения и внедрении новых технологий. Это неудивительно: IT-компаниям нужны авторы, которые пишут о цифровых продуктах для широкой аудитории понятным языком. С развитием рынка e-commerce специалистов стали также привлекать к созданию учебников для онлайн-школ.

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

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

Знания и навыки технического писателя

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

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

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

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

доступность для понимания читателя;

соответствие профессиональным стандартам;

Важным скилом техписа считается умение интервьюировать экспертов.

Знание профильных программ. Успешно стартовать в профессии не удастся без навыков работы в специализированных программах. Начать нужно с освоения текстового редактора. Научитесь создавать в нем чертежи, таблицы, диаграммы. Затем можно приступить к изучению более сложного ПО.

При трудоустройстве в компанию из IT-сферы одним из запросов работодателя может являться знание платформы DocBook/XML или ее аналога. Оно будет вам необходимо для автоматизированного создания стандартизированного контента по готовым макетам.

Нередко от специалистов ждут навыков ведения вики-систем с корпоративными базами знаний. Поэтому желательно заранее познакомиться с популярными сервисами для хранения деловых бумаг, например, Confluence или Yandex Wiki.

• Python;
• Java;
• JavaScript.

Автору в сфере информационных технологий как минимум необходим навык чтения кода. А знания HTML, CSS и Markdown станут еще более существенным преимуществом.

Как получить профессию технического писателя

В 2014 году появился квалификационный стандарт 06.019 для технических писателей в области IT. В нем описаны навыки и знания, которые необходимы для работы по профессии. Например, умение разрабатывать документы для сферы информационных технологий, создавать маркетинговые предложения и методическую литературу. Для авторов, специализирующихся на других направлениях, например, науке или производстве, профстандарты не предусмотрены.

Получить необходимые для работы в IT-компетенции можно двумя способами: поступить в образовательное учреждение или обучиться самостоятельно. Выбирать подходящий вариант придется самим. В первом случае при участии преподавателей будет проще приобрести системные знания и удостовериться в правильном понимании теории. Зато второй вариант — это неплохая возможность сэкономить средства на профильной подготовке.

Обучение в образовательных учреждениях

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

ВУЗЫ

Необходимые знания дают в высших учебных заведениях при подготовке по направлениям 09.03.01 «Информатика и вычислительная техника» или 09.02.07 «Информационные системы и программирование». Образовательная программа бакалавриата подразумевает знакомство с кодами и технической документацией в сфере IT.

• МАСИ;
• ВШЭ;
• РГСУ;
• РУТ (МИИТ);
• МГУПП;
• УГАТУ.

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

ССУЗЫ

За 36 месяцев профессиональную подготовку можно пройти в колледжах: НТИ НИЯУ МИФИ, РГСУ, КМПО РАНХиГС, КТ МТУСИ, «Синергия». Ссузы принимают абитуриентов по коммерческому договору и на бюджетные места. В качестве вступительных экзаменов засчитываются баллы по математике, русскому языку, информатике (ИКТ) и физике.

КУРСЫ

Стать техписом в рекордно короткие сроки позволят курсы, на которых студенты рассматривают и изучают в основном один главный предмет, а по остальным проходятся поверхностно. Учиться легче тем, кто хорошо владеет английским языком (B2 +) и знает компьютер на уровне уверенного пользователя.

Большое количество видеокурсов по бюджетным ценам можно найти на тематическом портале для технических писателей TechWriters.

Самообразование

Начинать самостоятельно карьеру в профессии непросто. Придется потрудиться. Освоить секреты авторского мастерства помогут книги:

• «Разработка технической документации» Вадима Глаголева.
• «Документирование программного обеспечения» Татьяны Макаровских.
• «Профессия «Технический писатель» или «Рыцари клавиатуры»» Александра Михайлова.

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

Бесплатные курсы для технических писателей:

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

Поиск работы

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

Теперь пора искать работодателей. В этом помогут известные job-сайты (hh.ru, superjob.ru, Работа.ру), а также телеграм-каналы. Актуальные вакансии периодически появляются на портале Yandex. Также можно попроситься на стажировку в агентства, которые специализируются на подготовке контента для заказчиков. Для поиска подходящей компании наберите в поисковике фразу «услуги технических писателей».

Подведем итоги

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

Как стать техническим писателем: чек-лист

• Изучить государственные и международные стандарты оформления документов.
• Овладеть ПО для создания инструкций, графиков, чертежей и ведения библиотеки.
• Научиться читать и понимать код на популярных языках программирования, например, Python, Java, JavaScript.
• Приобрести навыки обработки массивов информации, структурирования данных, написания контента на понятном для аудитории языке.
• Подготовить несколько образцов технического текста для портфолио и оформить резюме.
• Найти работу на job-бордах, в телеграм-каналах или агентствах, специализирующихся на подготовке документации.

Карьерный консультант. Эксперт по созданию резюме и подготовке к интервью. Профориентатор.

Посмотрите на ситуацию под другим углом

5 инструкций по оформлению cover letter на русском и английском языках

кандидат технических наук, Tech Lead Bercut

Мы — сплоченная команда технических писателей. Сейчас нас одиннадцать человек: десять писателей и один технический редактор-переводчик. Среди нас есть инженеры, программисты, филологи и педагоги. Мы все очень разные: по возрасту, характеру, увлечениям и образованию. Но нас объединяет одно общее интересное дело — документирование сложных систем и решений.

Бэкграунд

Меня зовут Александр Клименков, я — ведущий технический писатель, кандидат технических наук по специальности «Системный анализ, управление и обработка информации», закончил Санкт-Петербургский электротехнический университет («ЛЭТИ»). В компании Bercut работаю более 5 лет, очень люблю свою профессию. До прихода в Bercut работал преподавателем, техническим писателем и ведущим бизнес-аналитиком.

Процессы и коммуникации в новой дистанционной реальности

Как и большинство наших коллег в IT-сфере, сейчас мы работаем из дома. Переход на удалённый режим работы, конечно, внёс некоторые коррективы в нашу повседневную деятельность, но рабочие процессы от этого почти не поменялись. Мы всё так же пишем пользовательскую документацию, всё так же общаемся с коллегами в Teams и Skype, пользуемся теми же рабочими инструментами и серверами. Разве что звонки по местным телефонам мы заменили перепиской и созвонами в мессенджерах.

Биоритмы и конвенции

Режим рабочего дня, как и процессы, тоже не особо изменился. Ещё до перехода на удалённый режим в нашей компании каждый сотрудник мог выбирать время начала рабочего дня: кто-то приходил на работу в 8 утра, кто-то — в 11. Главное, чтобы все были на месте в определённый дневной период и работали положенные 8 часов. На удалёнке эти правила сохранились. Среди нас есть свои «совы» и «жаворонки» и каждый начинает рабочий день в удобное ему время. В любом случае проснуться можно попозже — ведь не нужно тратить время на утренние сборы и дорогу до работы.

Типичное рабочее утро писателя начинается с кружки крепкого кофе и обновления локальной копии из SVN. Нужно загрузить к себе изменения, которые другие писатели сделали за прошлый день. У читателя, не знакомого с нашей профессией, может сразу возникнуть вопрос: что же писатели хранят в SVN, ведь это не программисты, исходников у них нет. В том-то и дело, что есть. Об этом нужно рассказать подробнее.

Инструменты писателя

Мы пишем документацию в формате DITA. Это формат, основанный на XML, который позволяет сохранять исходный текст документов в структурированном виде. Мы пишем исходники документации в этом формате, для этого у нас есть редактор oXygen XML Author. Затем из этих исходников мы можем собрать итоговый документ в любом нужном формате. Для этого есть специальный Toolkit, содержащий XSLT-преобразования. Наш Toolkit позволяет собирать документы во множестве форматов. Самый востребованный — это PDF, иногда собираем CHM или HTML. При желании мы можем собрать даже EPUB, если заказчик вдруг захочет почитать нашу документацию перед сном на электронной книге. По необходимости мы вносим правки в XSLT-преобразования, чтобы изменить правила сборки документов и их внешний вид.

Подробнее о формате

Формат DITA вообще оказался очень удобным инструментом именно для разработки технической документации с её специфическим содержанием. Например, мы можем повторно использовать любой блок текста или целый раздел из одного документа в другом документе. И это будет не привычный «copy-paste», а именно использование одного блока в разных документах. Если в этом блоке что-то изменится, нам достаточно будет поменять текст один раз — изменение автоматически попадёт во все документы. Ещё мы можем применять фильтрацию — написать один универсальный раздел, вставить в несколько документов и потом фильтровать его содержимое в зависимости от типа документа, заказчика, системы и других параметров. А ещё мы не задумываемся о перекрёстных ссылках между разделами — достаточно в нужном месте указать ключ раздела, на который мы хотим сослаться. Toolkit при сборке документа сам пронумерует разделы и сделает красивые гиперссылки.

Погружение в процесс

Каждый писатель редактирует DITA-файлы у себя в локальной копии, а затем выгружает изменения в SVN. Часто бывает так, что над одним документом работает несколько писателей. Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария. Может, это и не самое технологичное решение, но оно работает. Никому из писателей не хочется потом «мёржить» (merge) куски сложных технических текстов.

После обновления локальной копии SVN начинается работа. Мы работаем по задачам в Jira. У нас есть специальный тип задач с префиксом DOC. Обычно они связаны с задачами на разработку или с запросами заказчиков. Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки. Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу. Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов.

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

Есть ещё один важный источник — описание настроек интеграционного тестирования. Там подробно описаны все настройки, которые нужно сделать в системах, чтобы пройти все тестовые сценарии (тест-кейсы). Этот источник незаменим для написания руководств по настройке.

ТП, ТО и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения.

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

Один в поле не воин

Часто думают, что технический писатель — это профессия, не требующая особых коммуникативных навыков. На практике оказывается, что для написания документации каждый день приходится консультироваться со множеством коллег: бизнес-аналитиками, разработчиками, тестировщиками. Бывает так, что в исходных документах авторы что-то опускают, что-то недоговаривают. Работа писателя — быть профессиональным занудой: уточнять, переспрашивать, перепроверять информацию много раз, чтобы правильно всё описать и не допустить ошибку в документе. Бывают случаи, когда писатели находят ошибки в реализации. Писатель выполняет свою работу на самом последнем рубеже перед отгрузкой системы и документации заказчику.

На поверку становись!

Когда писатель завершает работу над документом, он обязательно отправляет его на проверку. Документацию проверяют бизнес-аналитики, разработчики, тестировщики. Это очень важный этап, ведь писатель всегда может ошибиться — что-то неправильно понять, не учесть каких-то незадокументированных особенностей реализации.

Ещё наши документы проверяет наш профессиональный технический редактор. Он исправляет орфографические и грамматические ошибки, подчищает описки, следит за смысловой и логической чистотой документа, проверяет соблюдение руководства по стилю. Это руководство — наш маленький внутренний стандарт. В нём записаны разрешённые и запрещённые термины, правила оформления документов разных типов, приведены наиболее часто используемые фразы, конструкции и обороты. Руководство по стилю помогает нам писать документацию по общим для всех писателей правилам: единство стиля — прежде всего. В воображении читателя должен возникнуть собирательный образ одного крутого профессионала — писателя, который создаёт разные документы или разделы.

Праздник труда

Работа технического писателя не такая однообразная, как может показаться со стороны. Мы пишем очень разные документы — у нас есть и справочники с большими таблицами параметров или полей БД. Есть руководства пользователя с подробным описанием каждой кнопки интерфейса. Есть руководства администратора со множеством технических подробностей о работе и установке системы. Но самый сложный, и при этом самый интересный, тип документа — это руководство по настройке. В нём комплексно описывается реализация определённого решения в разных системах и подробно объясняется что и где нужно настроить, чтобы это решение заработало. Писателю приходится писать разные типы документов — сегодня часами описывать один за другим параметры системы, а завтра думать над тем, как понятнее и проще описать алгоритм работы решения в руководстве по настройке. Но в любом случае писатель должен быть внимательным, аккуратным и педантичным.

Клиент всегда прав — отгрузка до 23

Конечно, PDF-файлы — это не самый удобный формат пользовательской документации. К примеру, поиск нужной информации можно выполнять только в рамках одного PDF-файла. Нельзя поискать описание какого-то параметра сразу во всей документации по системе. Это очень неудобно, ведь количество документов на одну систему часто исчисляется десятками. Если не знать, в каком документе искать нужные данные, то поиск превращается в нетривиальную задачу. Сейчас мы работаем над созданием портала, на который сможем выгрузить документацию в формате HTML. Там будет предусмотрен удобный полнотекстовой поиск по всем страницам или по части документации, например, по страницам на определенную версию определенной системы.

Да здравствует Команда!

Также по пятницам у нас обычно проходит еженедельное совещание нашей команды в Skype. Эта традиция появилась у нас с переходом на удалённый режим работы. На совещании наш Team Lead делится с нами свежими новостями компании Bercut, рассказывает о новых краткосрочных и долгосрочных задачах и планах. Писатели по очереди рассказывают о своих задачах и рабочих проблемах — что сделано за прошедшую неделю, что планируется сделать на следующей. Такое обсуждение помогает нам скоординировать свои действия, ведь часто над пакетом документов к очередной версии системы работает сразу несколько писателей.

Последний штрих

Заканчивается рабочий день технического писателя тем же, чем и начинался — синхронизацией с SVN. Конечно, мы часто выполняем промежуточные синхронизации и в середине дня, но вечером обязательно проверяем, все ли изменения выгружены на сервер. Будет обидно, если вся работа, сделанная за день, пропадет даром. И конечно, надо не забыть оформить трудозатраты — вписать в задачи Jira время, которые мы на них потратили за этот день.

Призвание

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

Документерра как инструмент для обучения технических писателей

Документерра — российская разработка, поэтому мы предоставляем бесплатную лицензию для УрФУ. Мы понимаем, насколько важна практика для начинающих технических писателей, которые потом будут работать в России.

Вот почему Документерра идеально подходит для обучения студентов:

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

Действующие лица

Команда Документерры решила разобраться, как студенты учатся работать с документацией. Об этом нам рассказал Игорь Олегович Ситников — кандидат технических наук, преподаватель курса по технической документации в Уральском федеральном университете (УрФУ).

Онлайн-платформа для технической документации

Ситников Игорь Олегович

Преподаватель курса по технической документации в УрФУ

Баланс во всём

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

Если говорить про увлечения, то я люблю тяжёлые тренировки — это помогает сбросить напряжение и чувствовать себя лучше. Ещё я пишу стихи, у меня даже есть собственный сборник, но он пока в одном экземпляре. Иногда выступаю на городских площадках со своим творчеством.

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

Работа в Точке

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

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

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

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

Точка работает по Холакратии. Это система управления, при которой каждый сотрудник вправе самостоятельно принимать решения и нести за них ответственность перед всей командой. Секретарь в Холакратии — это выборная роль. Секретарь назначает встречи круга, а также записывает и публикует их итоги. Также секретарь

интерпретирует Конституцию Холакратии.

Кстати, ещё я пробовала работу UX-редактора. Когда у разработчиков появляется новый интерфейс, я могу предложить свою помощь: отредактировать тексты в интерфейсе, сделать их понятными и читабельными. Для меня как для технического писателя важны детали: я представляю опыт пользователя и уже заранее понимаю, какой может возникнуть вопрос.

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

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

Об образовании и перспективах

Технический писатель — это новая профессия, поэтому в университетах пока нет программ для подготовки таких специалистов.

Знаю, что уже разработаны специальные курсы на образовательных онлайн-платформах, но я не уверена в качестве многих из них. Если хочешь прийти в сферу, то специфику работы придётся осваивать самостоятельно. У технических писателей есть свой чат в Телеграм — пиши, если не знаешь, с чего начать, или если нужен совет.

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

Технический писатель — кто это?

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

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

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

Какие перспективы у профессии «технический писатель»?

Искусственный интеллект на наших глазах учится рисовать картины все лучше — например, нейросеть Midjourney прекрасно генерирует изображения на основе текста. В связи с этим художники со всего мира беспокоятся о том, что их профессия может стать ненужной в скором будущем.

Появляется закономерный вопрос: а что ждёт IT-область в общем и технических писателей частности? Кажется, что генерировать текст не сложнее, чем изображения. Насчёт этого мы спросили нашего эксперта.

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

По-моему, искусственный интеллект не заменит труд технических писателей, пока человек остается источником потребности в новом ПО и генератором идей по реализации такой потребности.

О старте карьеры

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

Спустя время мне стало скучно, и я перевелась в продажи — «толкала» по телефону бонусную программу и более выгодные тарифы.

Когда отдел продаж расформировали, я решила поработать в техподдержке. Руководитель группы меня спросил: «Роутер сможешь настроить?», ответила: «Смогу». Так я несколько лет настраивала краснодарцам разное сетевое оборудование и чинила интернет по телефону, пока не переехала в Екатеринбург, где продолжила заниматься тем же самым.

Через несколько лет я выгорела. Вариант был только один – менять сферу деятельности. Меня заинтересовала вёрстка и программирование на JS. За полгода я узнала всё самое базовое и научилась писать код сама. Чуть позже поняла, что мне нужен наставник и реальные проекты. Прошла несколько собеседований и выполнила множество тестовых заданий, чтобы получить должность фронтенд-разработчика. Потом меня всё же взяли на позицию junior-фронтендщика делать сервисы торговой компании.

Там я проработала год, пока не заскучала. После я решила делать то, что у меня хорошо получалось — писать тексты. Но я не собиралась забывать все, что знаю о технических штуках. Поэтому занялась поиском места, где смогла бы объединить все свои скиллы. Так я и нашла позицию технического писателя в Точке.

Кто такой техписатель

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

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

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

Если говорить обо мне, то я всегда была больше гуманитарием: мне легко писать тексты, учить языки и заниматься творчеством. Но в школе мне повезло с учителями по математике, в итоге я понимаю алгоритмы и немного умею кодить. В совокупности эти навыки стали отличной базой для моей профессии.

Что должен уметь технический писатель?

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

Мои студенты проходят практическую часть курса на Документерре. Там они учатся:

1) создавать проекты,

2) импортировать документы из различных форматов,

3) редактировать страницы,

4) применять технологию единого источника,

5) экспортировать проект в финальные форматы.

Игорь Олегович уделяет особое внимание технологии единого источника, которая позволяет использовать один фрагмент контента сразу в нескольких местах.

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

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

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

Как долго учиться на технического писателя?

В университетах на профессию «технический писатель» не учат, есть только курсы. У них разная продолжительность: от пары дней до нескольких месяцев. Например, Игорь Олегович как раз ведет курс для студентов УрФУ.

Я веду курс «Современные технологии разработки технической документации» с 2017 года. Мои студенты — магистранты УрФУ. Они не учатся именно на технических писателей: их специальность гораздо шире. Но работа с документацией — важная компетенция для них.

Мой курс длится 36 часов. Четверть из них занимают лекции, а остальную часть — лабораторные работы. На все уходит чуть больше двух месяцев.

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

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

Заключение

Мы поговорили с Игорем Олеговичем об обучении технических писателей и поняли следующее:

• Знать основы технического писательства недостаточно для работы. Необходимо также хорошо разбираться в прикладной области — например, в химии или медицине.
• В университетах не учат на специальность «технический писатель», нужно проходить курсы. Их продолжительность — от пары дней до нескольких месяцев. Мы как раз недавно делали обзор курсов для техписов, рекомендуем почитать: «ТОП‑6 курсов для технических писателей».
• Чтобы работать с документацией профессионально, необходимо использовать такие функции, как технология единого источника, создание динамического контента, экспорт и импорт проектов в различные форматы и не только. Все это можно сделать в Документерре.
• Поскольку людям еще долго будет нужна документация, можно смело осваивать эту специальность.

Игорь Олегович и его студенты способствуют развитию профессии «технический писатель» в России. Мы очень рады помогать им, предоставляя бесплатную лицензию Документерры, ведь для начинающих специалистов важен опыт работы с профессиональным инструментом.

Мы желаем Игорю Олеговичу успехов в преподавании, а нашим читателям — в освоении профессии «технический писатель».