Кто такие технические писатели и зачем они нужны в команде

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

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

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

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

Часто люди обращаются к инструкциям только тогда, когда становится совсем непонятно или что-то идет не так. Хорошо, если это произойдет до того, как что-нибудь будет сломано, иначе скажут – продукт плохой. Технический писатель должен предусмотреть такие ситуации: предупредить о возможной поломке, описать ее, предложить решение.

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

В каждой организации, где в штате есть технический писатель, обязанности его зависят от того, какие задачи стоят в ближайшей перспективе:

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

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

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

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

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

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

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

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

Вот как строится процесс работы:

1. Определение главных задач документации и ее аудиторию.
2. Составление плана технической документации и согласование его с заказчиком. Здесь скорее всего, будут изменения, поэтому важнее понять какие вопросы хочет решить заказчик.
3. Изучение как работает программа или устройство. На этом этапе важно найти экспертов, кому можно будет задавать уточняющие вопросы и договориться о формате работы с ними. Обязательно уточнить что непонятно у инженеров.
4. Поиск и подготовка иллюстрации к тексту.
5. Наполнение документа текстами и отправка его на проверку экспертам.
6. Внесение правок от разработчиков и экспертов.
7. Презентация документации заказчику.
8. Передача документации команде.

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

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

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

Soft skills и Hard skills технического писателя в концепции Модели компетенций команды цифровой трансформации в системе государственного управления подробно описаны в Профиле роли.

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

Из основных требований к знаниям и навыкам технического писателя можно выделить:

• умение составить понятный, грамотный, подробный, логичный технический текст;
• понимание процесса документирования и его взаимосвязи с другими процессами;
• знание инструментов для разработки электронных справок (Microsoft HTML Help Workshop, Help&Manual, RoboHELP);
• знание технологий и средств для автоматизации документирования (AuthorIT, DocBook/XML, DITA, SiberSafe);
• знание языков разметки (HTML, XML и его приложения) и навыки работы с ними;
• знание языков программирования, позволяющих автоматизировать разработку технической документации (VBA, XSLT);
• представление о методологии и языках моделирования (IDEF0, DFD-диаграммы, ER-диаграммы, UML).

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

Большинство организаций, в том числе ГосIT предъявляют жесткие требования по знанию нормативных документов и требования, в частности, ГОСТ ( ГОСТ 5, ГОСТ 19 и ГОСТ 34). Для международных компаний необходимо знание ISO, IEEE

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

На некоторых проектах техническим писателям требуется знание специфических программ: AutoCAD, Visio, Corel Draw, Confluence, Jira, UML, SysML, IDEF. Часто работа идет в стандартных текстовых редакторах и программах для работы с изображениями.

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

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

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

«Зачем мне технический писатель, если есть разработчик продукта, который запросто сможет создать документацию к нему?» – такой вопрос часто задают себе руководители компаний по разработке программного обеспечения. Если проект небольшой, то возможно, технический писатель совсем не нужно. Но есть огромные преимущества, когда в проекте есть технический писатель.

– Более четкие коммуникации.

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

– Снижены затраты на техническую поддержку.

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

– Сниженные затраты на документацию.

Технические писатели могут писать лаконичнее без потерь в качестве, что в результате даёт более короткие инструкции и сниженные расходы на печать: менее объёмные документы требуют меньше времени на проверку, тем самым снижаются расходы на неё; на коротких документах проще сосредоточиться, соответственно улучшается качество проверки. Основная работа технического писателя – писать, и профессиональные писатели создают документацию быстрее, чем разработчики продукта. Даже если найдётся тот редкий разработчик, который пишет быстро и эффективно – он запросто может обойтись вам в два раза дороже по оплате труда в час, чем технический писатель, и пока пишет, он не будет производить ничего, что вы сможете продать. Наём технического писателя не только снижает затраты на разработку документации, но и освобождает разработчиков продукта для работы, на которую они были наняты.

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

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

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

На июль 2021 года на известном ресурсе по поиску работы были найдены 335 вакансии по Москве и Московской области. С примером описания вакансии можно ознакомиться здесь.

Средний размер заработной платы: от 100 000 до 150 000 рублей.

Если технический писатель принял решение работать как фрилансер, то ежемесячный уровень дохода примерно 150 000 – 200 000 рублей при наличии опыта от 3х лет.

Первые заработки начинающих технических писателей начинаются от 5 000 – 10 000 рублей за проект.

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

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

Спрос на технических писателей неуклонно растет и многократно превышает предложение: раньше технических писателей не было вообще, а теперь они нужны почти каждой IT-компании.

Наталья Карташева,
Эксперт центра