Автор технических текстов

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

Краткий обзор: кто такой техрайтер

Автор технических текстов (техрайтер, techwriter) занимается созданием документации для решения всевозможных технических проблем. Он может создавать инструкции по использованию приборов или разрабатывать и обновлять документацию по компьютерным программам. Основная задача такого специалиста – разъяснить, как максимально эффективно использовать возможности гаджета, оборудования или программы. Важно, чтобы текст был доступен для понимания и легко читался уже после первого прочтения.

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

Обязанности

Стандартные функции технического автора:

• Определить потребности пользователей в технической документации, понять, какие аспекты требуют подробного объяснения.
• Изучить образцы продуктов, провести консультации с дизайнерами и разработчиками.
• Уточнить детали у технического персонала, непосредственно работающего над созданием продукта, чтобы сделать инструкции максимально понятными и простыми.
• Создать и написать руководство по эксплуатации, инструкцию пользователя и т. д.
• Создать или отредактировать дополнительную документацию (информационный контент и др. ).
• Редактировать материалы, подготовленные другими авторами или сотрудниками.
• Стандартизировать контент на различных платформах и носителях.

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

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

Роль технического писателя в сфере IT

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

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

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

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

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

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

Место работы технического писателя:

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

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

Специфика труда

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

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

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

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

Необходимые качества

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

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

Чтобы стать техническим писателем в IT-компании, необходимо обладать следующими качествами:

• любопытством;
• упорством;
• внимательностью;
• терпимостью.

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

Важно усвоить навык корректного общения с программистами, что позволит глубже проникнуть в функционал программного обеспечения

Знания и умения

• Требуется обладать достаточными техническими знаниями, которые позволят разбираться в новинках, иметь системное представление о документировании как инженерной области, осознавать процессы документирования.
• При разработке новой программы важны базовые навыки в области программирования. Для создания иллюстраций необходимо владение графическими программами (Adobe PhotoShop и др. ) .
• Часто необходимо владеть техническим английским в письменной форме, знать ГОСТы по оформлению технических проектов.
• Ключевой навык - умение ясно формулировать свои мысли в письменной форме.

Обучение для технического писателя

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

Если ваша цель - стать техническим писателем в сфере ИТ, вот несколько шагов, которые стоит предпринять:

• Изучите Microsoft Manual of Style и ознакомьтесь с подходами к составлению документации от ведущих технологических компаний. Это поможет вам научиться четко, последовательно и стилистически грамотно представлять информацию.
• Если вы планируете работать в аутсорсинговой компании, вам необходимо хорошо владеть иностранным языком, преимущественно английским.
• Получите начальные навыки работы с HTML, XML, CSS, SQL.
• Познакомьтесь, хотя бы на базовом уровне, с системной и программной инженерией - это будет значительным преимуществом.
• Освойте основные инструменты, которые используются техническими писателями, включая Microsoft Word, Microsoft HTML Help Workshop, Help&Manual, AutorIT, RoboHELP, MadCapFalre, MadCap Software (для создания электронной справки), DocBook/XML, DITA, SiberSafe (для автоматизации процесса документирования), Adobe FrameMaker.

Заработная плата

Уровень дохода технического писателя определяется не только его квалификацией, но и размером компании, где он трудится. На рынке можно найти предложения от малых компаний с заработной платой в 40–50 тысяч рублей. Это отличная возможность для начала карьеры, после чего можно перейти, например, в SberTech и зарабатывать уже 200 тысяч.

Средняя зарплата технического писателя на октябрь 2023

Сведения о заработной плате представлены на веб-ресурсе hh. ru.

Страна: Россия от 40000 до 100000₽

Город: Москва от 75000 до 220000₽

Профессиональное развитие

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

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

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