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

Анна Гаспарян, технический писатель в команде IntelliJ IDEA

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

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

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

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

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

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

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

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

Инструментарий технического писателя?

Как я уже сказала, мы пишем документацию в IDE IntelliJ IDEA, используя специальный плагин, разработанный нашей командой Internal Development. Мы пишем на языке XML, используя адаптированную под наши задачи схему. Весь исходный код хранится в системе контроля версий Git.

Каковы требования компании к уровню образования потенциальных сотрудников?

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

Обычно техническими писателями становятся люди с филологическим образованием, так как они отлично умеют писать на английском языке, или «технари» с отличным знанием английского (но таких меньше).

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

Какие требования предъявляются к опыту работы?

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

Есть ли особые требования, которые обусловлены спецификой деятельности компании?

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

Технический писатель должен:

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

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

Полная версия интервью опубликована на портале Системный администратор.