iTechArt logo

Кто такой технический писатель и что нужно, чтобы им стать

Students Lab Development & QA

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

Эта профессия востребована там, где возникает необходимость в разработке различных видов документации, в том числе и в IT-аутсорсинге. По случаю появления в нашей базе вакансий позиции «технический писатель»,а также аналогичной стажировки решили рассказать о ней подробнее. Обзор функционала и карьерных возможностей для нас сделала Регина Усович, Technical Writer iTechArt.

Наша собеседница
Усович Регина.jpg

Регина Усович

Technical Writer iTechArt

Считает, что техническими писателями могут быть как "лирики", так и "физики". Главное – проявлять интерес, желание и усилие.

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

Мыслит как читатель и описывает сложное просто.

Что входит в число обязанностей технического писателя в IT-компании?

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

Как организован рабочий процесс технического писателя? Какое место он занимает в команде проекта? С какими сотрудниками они чаще всего взаимодействуют? И всегда ли его необходимо подключать?

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

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

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

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

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

Чем отличается технический писатель от бизнес-аналитика? Из какой IT-профессии проще всего прийти в техническое писательство?

Многие почему-то сводят эти профессии в одну и думают, что это почти одно и то же, но я с этим не согласна. Если говорить кратко, профессия бизнес-аналитика больше про «Как это работает?», а профессия технического писателя про «Как этим пользоваться?». Бизнес-аналитик – это человек на «входе», который собирает информацию о том, как работают отдельные части функциональности и анализирует, насколько функциональность будет полезна для бизнеса заказчика. В свою очередь, технический писатель – это человек на «выходе»: он анализирует информацию, предоставленную командой и бизнес-аналитиком, после чего принимает решение, какую инструкцию предоставить пользователю, в каком виде, что ему будет полезно знать, чего можно ожидать от приложения и что нужно делать в неожиданных ситуациях.

Регина Усович, Technical Writer iTechArt.

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

Насколько работа техническим писателем стрессовая?

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

Какие требования предъявляются к техническому писателю на старте карьеры? Что нужно знать обязательно, а какие компетенции входят в разряд nice-to-have?

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

Регина Усович, Technical Writer iTechArt.

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

Что касается цикла разработки, то от будущего технического писателя ожидают понимание того, какие есть стадии этого цикла, какие роли существуют и какова роль непосредственно технического писателя. Не обязательно разбираться во всех тонкостях различий Scrum и Kanban, но будет плюсом, если кандидат владеет такими знаниями.

Наконец, владение текстовым редактором. Не нужно знать Word на уровне макросов, если этого не требуют на проекте. Текстовый редактор – это просто инструмент. Если владеть им на уровне «могу сделать автооглавление» или «могу создать и настроить стили» - этого будет предостаточно, да и то можно нагуглить и разобраться за небольшой промежуток времени. Из разряда nice-to-have – чтение соответствующей литературы о том, как писать документацию. На сегодняшний день существует 2 «настольные книги» для технического писателя – Microsoft Manual of Style и Google Developer Documentation Style Guide. Хотя бы разок почитать – и в голове сложится понимание, какая документация ожидается от будущего технического писателя.

Актуальны ли для технических писателей градации типа junior, middle, senior?

Градацию позиций технических писателей иногда указывают, а иногда нет (прим. в iTechArt подобное разделение отсутствует). Возможно, из-за того, что профессия молодая и никто пока не понял, по каким критериям все-таки нужно разграничивать технических писателей. По количеству написанных гайдов не оценишь, по уровню владения языком тоже – у разных компаний разный запрос на уровень языка, могут просить и «джуна» со знанием английского Advanced. Чаще всего встречаю позиции без градации.

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

Если из словосочетания «технический писатель» развить всё, что касается технических вопросов, то есть много вариантов развития, особенно в рамках IT-сферы. Учитывая знание продукта и возможных вариантов его использования, можно уйти в тестирование, а можно развить коммуникативные и аналитические навыки и построить карьеру бизнес-аналитика. Если документирование предполагает использование приложения для разработки документации, где используется XML/HTML, то можно поставить цель и уйти даже в front-end разработку. Если развивать часть «писатель», то можно уйти в технический перевод или локализацию. Профессия технического писателя многогранна, поэтому можно развивать и комбинировать знания для продвижения по карьерной лестнице или смены сферы деятельности.