Почему IT-компании нужен технический писатель?

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

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

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

• Документацию к коду.
• Инструкции.
• Контент. 

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

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

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

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

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

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

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

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

• Инструменты для управления проектами: Jira, Confluence, Asana, Trello и тд.

• Репозитории. Например, GitHub. 

• Сервисы для создания mind map. Например, Obsidian.

• Текстовые и графические редакторы.

• Инструменты для совместной работы: от Google Doc до Figma. 

• Wiki.

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

С кем в компании взаимодействует технический писатель?

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

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

Как стать техническим писателем и куда расти?

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

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

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

• Умение и желание учиться новому.

• Способность искать нужную информацию. 

• Хорошие коммуникативные навыки.

• Способность качественно структурировать информацию.

• Знание азов написания текстов и работы с языком.

• Полезным будет знание английского языка. 

Какие карьерные перспективы есть у технического автора? Очевидно, если в компании есть целый штат подобных специалистов, есть возможность прокачать и грейд (от junior до senior), и должность — стать старшим автором, руководителем отдела и т.д, в зависимости от принятой в компании градации.

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

Заключение

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

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

Если вы поняли, что вам необходим технический писатель, напишите нам. В Evrone есть готовые опытные специалисты для ваших задач. С нами вы сэкономите время на поиске и подборе идеального кандидата.