Карьера в IT: должность Technical Writer

Представляем десятую статью серии «Карьера в IT». В этой части цикла поговорим о должности технического писателя — посредника между разработчиками продукта и конечными пользователями. Предыдущие материалы цикла были посвящены должностям Team Lead, Software Architect, Project Manager, CTO, QA engineer, QA Automation engineer, Бизнес-аналитик, Системный администратор и Data Scientist / Machine Learning Engineer.

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

По данным ДОУ, среднему украинскому техническому писателю 28 лет, у него 3,5 года опыта работы и зарплата $400-1400. Соотношение женщин и мужчин на этой должности — примерно 50/50.

Задачи и обязанности

Основная задача Technical Writer — грамотно создавать, иллюстрировать и адаптировать документацию на понятном для конечного пользователя языке. Материал может предназначаться для потребностей команды/проекта (внутренняя) или для клиента продукта (внешняя).

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

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

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

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

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

«Фактически, технический писатель сталкивается не только с технической документацией, а и с другими материалами. Иногда доводится писать, редактировать или переводить release notes, software requirements specification, CV, PowerPoint презентации, meeting minutes, user stories и даже технические книжки, а также записывать обучающие how-to видео туториалы».

Основные инструменты технического писателя — текстовый редактор, диктофон, а также, в зависимости от особенностей проекта, руководства MS Manual of Style, Apple Style Manual, Chicago Manual of Style, программы MS Word, Adobe FrameMaker (для создания оффлайн-материалов), Adobe RoboHelp, MadCapFalre (для онлайн-документации) и другие.

Прежде всего, Technical Writer узнает, кто именно выступает экспертом предметной области (Subject matter expert) поставленного задания, и проводит с ним интервью — узнает все подробности про новый функционал. Затем анализирует, раскладывает систему на простейшие элементы, и в виде документации выдает результат конечному пользователю.

«Чаще всего я тесно работаю с программистами и product owner’ом. Последний дает общее направление по новинкам, которые следует включить в документацию, какие материалы корректно использовать, какие общие требования по оформлению документации согласно требованиям конкретного региона следует соблюсти. Программисты помогают мне разобраться в сути новых опций».

Типичный рабочий день Technical Writer включает в себя:
— Всестороннее изучение того, что должно быть включено в документацию в будущем (если релиза продукта еще нет);
— Создание новой документации для непокрытой функциональности;
— Обновление документации.

«Я занимаюсь написанием руководства для пользователей десктопного приложения, мне нужно понятно и доступно донести до них техническую информацию. Так как я почти всегда пишу „по живому“ (когда проект находится еще в стадии разработки), я волей-неволей выполняю функцию тестера. Но баги не репорчу сама, а сообщаю о них тестерам. Знаю, что в некоторых компаниях техписатели могут сами репортить баги».

Достоинства и недостатки

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

«Сейчас я понимаю, что это работа не для всех. Чтобы быть tech writer’ом, недостаточно просто уметь писать. Документация — это специфический жанр, который нужно понять, принять и не отклоняться от него, если хочешь добиться результатов. Он не терпит фривольностей».
«Я всегда хорошо писала и свободно владею иностранным языком. Должность технического писателя оказалась идеальным компромиссом между возможностью писать, не терять языковые навыки, и достойно зарабатывать. А еще я очень люблю общаться. Моя работа предполагает постоянное общение с программистами и менеджерами, — в некоторой степени это и привлекло меня в эту профессию».
«Очень приятен процесс профессионального роста. Начинаешь понимать технические штучки, потихоньку осваиваешь язык разметки».

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

«Главный минус специальности — ограничение в способах выражения. Техническая документация не позволяет свободных фраз. Все обусловлено стандартами manual of style, даже порядок слов и типы предложений. Впрочем, если полёт мыслей в тексте — не ваш конёк, и вместо того, чтобы выдумывать, вам проще написать в рамках правил, тогда техническая документация — для вас».
«Самый главный недостаток для меня — невозможность влиять на функциональность ПО. Только описание уже созданной функциональности».
«Не все понимают суть работы технического писателя и потому считают, что могут вкладывать в нее „новые обязанности“. 80% времени технический писатель занимается всем, чем угодно, только не техническим писательством».

Также упоминали о пренебрежительном отношении со стороны программистов:

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

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

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

Не менее, чем системное аналитическое мышление, важны и коммуникативные навыки, умение общаться.

«Нужно уметь задавать разработчикам правильные вопросы, чтобы досконально изучить возможности ПО».

Что касается профессиональных знаний, то этой специальности не учат в университетах, а потому будущий tech writer должен освоить профессию самостоятельно: прочитать Microsoft Manual of Style, исследовать стиль написания документации больших технических компаний, научиться грамотно, последовательно, доходчиво и стилистически правильно излагать информацию.

«Важно много практиковаться — например, описать функциональность MS Word и дать почитать кому-то из старших родственников. Если они без проблем действуют по вашей инструкции — поздравляю, у вас есть задатки для tech writing!».

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

Стоит ознакомится с основными инструментами и технологическими средствами, которые используют технические писатели: Microsoft HTML Help Workshop, Help&Manual, RoboHELP, MadCapFalre, MadCap Software (разработка электронной справки), AuthorIT, DocBook/XML, DITA, SiberSafe (автоматизация документирования), Adobe FrameMaker, Microsoft Word, OpenOffice (подготовка технических публикаций), работа с IDEF0, DFD- и ER-диаграммами, UML.

«Мне кажется,что техническое образование все же предпочтительней. Но в нашей стране в этой профессии больше лингвистов».

Перспективы карьерного развития технического писателя:
— Расти как Technical Writer, углубляться в специальность;
— Вертикальный рост: стать руководителем подразделения технических писателей;
— Переквалифицироваться в бизнес-аналитика, тестировщика или верстальщика (если больше интересует техническая сторона);
— Двигаться в маркетологи или PR-отдел (если больше привлекает творчество).

На заметку: Если вас интересует правильная настройка яндекс директ, то в таком случае мы рекомендуем вам посетить сайт http://xn-----6kcavbfcxglfd3akg7ahkqel41a.xn--p1ai/.

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



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


Остальные статьи цикла:
— Карьера в IT: должность Team Lead
— Карьера в IT: должность Software Architect
— Карьера в IT: должность Project Manager
— Карьера в IT: должность CTO
— Карьера в IT: должность QA engineer
— Карьера в IT: должность QA Automation engineer
— Карьера в IT: должность Бизнес-аналитик
— Карьера в IT: должность системный администратор
— Карьера в IT: должность Data Scientist / Machine Learning Engineer

alt

Похожие статьи:
Засновник і CEO EPAM Аркадій Добкін опублікував пост в LinkedIn, де висловився проти війни в Україні. Він підтримав нашу країну та виступив...
DOU повертається з новим випуском рубрики, присвяченій запитанням на співбесідах, що допоможуть пошукачам роботи якісно...
Редакція DOU запускає рейтинг банків за кількістю ІТ-спеціалістів. До нього потрапили банки, які працюють в Україні....
Новые версии ReactOS 0.4.0 Kotlin 1.0 Vulkan 1.0 Docker 1.10 Go 1.6 TypeScript 1.8 htop 2.0 ESLint v2.0.0 FFmpeg 3.0 GitLab 8.5 Аналитика Ukraine has an army of nearly 100,000 IT...
На последнем проекте у меня как UX-дизайнера возникла необходимость поделиться базовыми знаниями UX с командой...
Яндекс.Метрика