Технический писатель

Технический писатель
Описание
Область деятельности	Разработка и создание технической документации для различных продуктов, услуг и систем.
Cпециализация	Программное обеспечение, Аппаратное обеспечение, Медицинская техника, Инженерно-техническая документация, Веб-документация, Обучающие материалы
Деятельность	Анализ, Планирование, Написание, Редактирование, Взаимодействие, Тестирование, Локализация
Компетенции	Письменная коммуникация, Техническое понимание, Анализ информации, Работа с инструментами, Знание стандартов, Работа в команде, Организованность и внимательность к деталям
Образование	Высшее образование в области технических специальностей, журналистики, филологии или смежных областях. Специализированные курсы по техническому письму.

Технический писатель (англ. technical writer, technical author) — специалист, занимающийся документированием в рамках решения технических задач, в частности разработки программного обеспечения.

Основная задача технического писателя — написание документа, который бы удовлетворял определённым требованиям.

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

Примеры отраслей, в которых заняты технические писатели:

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

История профессии

На Западе первые упоминания о профессии «технический писатель» (technical writer, technical communicator) встречаются со времён Первой мировой войны, когда разработка технической документации для военных целей стала острой необходимостью. Название должности появилось в США во время Второй мировой войны, хотя только в 1951 году было опубликовано первое объявление с текстом «Требуется технический писатель». Фактически должность «Технический писатель» не добавлялась в Справочник по профессиональной занятости Бюро статистики труда США до 2010 года. В 1940-50-х годах были наняты технические коммуникаторы и писатели для создания документации для военных, часто включающей подробные инструкции по новому вооружению. Другие технические коммуникаторы и писатели были вовлечены в разработку документации для новых технологий, которые были разработаны примерно в это время. По словам американского историка О’Хара,

Война была важнейшим двигателем научно-технического прогресса. Медицинский корпус армии США боролся с малярией в джунглях Панамы, химический корпус продвигал достижения в области взрывчатых веществ и ядовитых газов (и защиты от них), инженерный корпус Манхэттенского проекта совершил качественный скачок в понимании физики, а Авиационный корпус был пионером в области авиационного дизайна.

—

В РФ в начале 2012 года Ассоциацией предприятий компьютерных и информационных технологий (АП КИТ) утверждён профессиональный стандарт «технический писатель».

Карьера и перспективы профессии

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

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

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

По оценкам Министерства труда США в апреле 2021 года, занятость технических писателей будет ежегодно расти на 7 процентов с 2019 по 2029 годы, что опережает рост рынка труда в целом. Возможности трудоустройства, особенно для соискателей с техническими навыками, в этот период будут благоприятными. Федеральное бюро статистики труда США также отметило, что распространение «научно-технических продуктов» и потребность в «поддержке продуктов через Интернет» с помощью технических писателей будет стимулировать рост спроса на последних.

По данным рекрутингового сервиса ZipRecruiter, по состоянию на июнь 2021 года средняя годовая зарплата внештатного технического писателя в США составляла $ 70 191. Профессия входит в список ТОП-50 самых востребованных профессий среднего профессионального образования по версии Минтруда РФ.

Технический писатель и дизайн пользовательского интерфейса (UX)

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

Ассоциация профессионалов по опыту пользователя определяет UX как «Каждый аспект взаимодействия пользователя с продуктом, услугой или компанией, которые составляют восприятие пользователя в целом».

Теперь ожидается, что навыки технической коммуникации должны сочетаться с дизайном UX. Как заявляют Верхульсдонк, Ховард и Там:

«…недостаточно просто писать хороший контент. Согласно ожиданиям отрасли, наряду с написанием хорошего контента, теперь также очень важно проектировать хороший опыт работы с этим контентом».

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

Как объясняет Редиш, специалист по технической коммуникации больше не пишет контент, а «пишет вокруг самого интерфейса», поскольку разрабатывается пользовательский опыт, окружающий контент. Это включает в себя удобный контент, адаптированный к конкретным потребностям пользователей, который учитывает эмоции, чувства и мысли пользователей на разных каналах в экологии UX. Редиш, Джинни. (2020, 30 сентября). «UX-письмо — новая роль для технических коммуникаторов? Мастер-класс по технической коммуникации для Общества технической коммуникации» (Вашингтон, округ Колумбия, и Балтимор).

Лауэр и Брумбергер далее утверждают, что «…UX является естественным расширением работы, которую уже выполняют технические коммуникаторы, особенно в современном технологическом контексте адаптивного дизайна, в котором контент развёртывается на широком диапазоне интерфейсов и сред».

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

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

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

• Бизнес-анализ
• Компьютерное скриптирование
• Управление контентом
• Дизайн контента
• Иллюстрация/графический дизайн
• Индексирование
• Информационная архитектура
• Информационный дизайн
• Локализация/технический перевод
• Обучение
• Электронное обучение
• Пользовательские интерфейсы
• Видеомонтаж
• Веб-дизайн/управление веб-сайтами
• Язык разметки гипертекста (HTML)
• Тестирование юзабилити
• Решение проблем
• Дизайн пользовательского опыта {{Div col end}}

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

Характеристики

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

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

По словам Маркела, полезные технические документы измеряются по восьми характеристикам: «честность, ясность, точность, полнота, доступность, краткость, профессиональный вид и правильность». Технические писатели сосредоточены на использовании своих тщательных исследований для создания эффективных документов, которые отвечают этим восьми характеристикам.

Роли и функции

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

Анализ аудитории

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

При анализе аудитории технический писатель обычно спрашивает:

• Кто является целевой аудиторией?
• Каковы их демографические характеристики?
• Какова роль аудитории?
• Как читатель относится к теме?
• Как читатель относится к отправителю?
• Какую форму ожидает читатель?
• В чём заключается задача аудитории?
• Почему аудитория должна выполнить эту задачу?
• Каков уровень знаний аудитории?
• Какие факторы влияют на ситуацию?

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

Цель

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

Контекст

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

Дизайн документа

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

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

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

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

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

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

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

Квалификация

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

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

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

Жизненный цикл разработки технической публикации обычно состоит из пяти фаз, скоординированных с общим планом разработки продукта

• Фаза 1: Сбор информации и планирование
• Фаза 2: Спецификация контента
• Фаза 3: Разработка и внедрение контента
• Фаза 4: Производство
• Фаза 5: Оценка

Жизненный цикл разработки документа обычно состоит из шести фаз (это меняется от организации к организации, как они следуют).

Это похоже на жизненный цикл разработки программного обеспечения.

Хорошо написанные технические документы обычно следуют формальным стандартам или руководящим принципам. Техническая документация существует в различных стилях и форматах в зависимости от среды и предметной области. Печатная и онлайн-документация могут отличаться различными способами, но все же придерживаться в значительной степени идентичных рекомендаций по прозе, структуре информации и макету. Обычно технические писатели следуют соглашениям о форматировании, описанным в стандартном руководстве по стилю. В США технические писатели обычно используют «Справочник по стилю Associated Press» или «Чикагское руководство по стилю» (CMOS). Многие компании имеют внутренние корпоративные руководства по стилю, которые охватывают конкретные корпоративные вопросы, такие как использование логотипа, брендинг и другие аспекты корпоративного стиля. «Руководство по стилю Microsoft для технических публикаций» типично для таких руководств.

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

Рабочая среда

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

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

Удалённая работа во время и после пандемии COVID-19

После рекомендаций Всемирной организации здравоохранения оставаться дома в марте 2020 года из-за пандемии COVID-19 сотрудники по всему миру столкнулись со сменой рабочей среды с личного общения на удалённую и/или виртуальную. По состоянию на 2023 год, после ослабления мер социального дистанцирования, многие организации решили сохранить возможность для сотрудников работать удалённо. В частности, для профессиональных технических писателей это изменение требует альтернативного подхода к общению с экспертами по предмету, коллегами и менеджерами проектов, которые непосредственно участвуют в процессе технической коммуникации. Сотрудники, работающие удалённо, обычно полагаются на виртуальное, иногда асинхронное общение с сотрудниками и проводят рабочие часы либо дома, либо в изолированном офисе.

Профессиональный рост

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

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

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

В апреле 2021 года Министерство труда США ожидало, что занятость технических писателей вырастет на 7 процентов с 2019 по 2029 год, что немного быстрее, чем в среднем по всем профессиям. Они ожидают, что возможности трудоустройства, особенно для кандидатов с техническими навыками, будут хорошими. Бюро статистики труда также отметило, что расширение «научных и технических продуктов» и необходимость работы технических писателей в «веб-поддержке продуктов» приведут к росту спроса.

По состоянию на май 2022 года средняя годовая заработная плата внештатного технического писателя в Соединённых Штатах составляет 70 191 доллар США, согласно ZipRecruiter.

Высшие учебные заведения для работы техническим писателем

1. Московский государственный лингвистический университет (МГЛУ)

  - Факультет: Переводческий факультет
  - Программы: Перевод и межкультурная коммуникация с акцентом на технический перевод.

2. Национальный исследовательский университет «Высшая школа экономики» (НИУ ВШЭ)

  - Факультет: Школа лингвистики и Факультет коммуникаций, медиа и дизайна
  - Программы: Лингвистика и технический перевод, редакция и создание технической документации.

3. Московский политехнический университет

  - Факультет: Информационные системы и технологии
  - Программы: Техническая коммуникация и разработка документации.

4. Санкт-Петербургский политехнический университет Петра Великого (СПбПУ)

  - Факультет: Институт компьютерных наук и технологий
  - Программы: Техническая документация и инженерные коммуникации.

5. Московский государственный технический университет имени Н. Э. Баумана (МГТУ им. Баумана)

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

6. Российский государственный гуманитарный университет (РГГУ)

  - Факультет: Факультет рекламы и связей с общественностью
  - Программы: Техническое редактирование и документация.

Известные технические писатели

• Тед Чьянг, американский автор рассказов, в том числе «История твоей жизни» (1998) и «Торговец и врата алхимика» (2007), был техническим писателем в программной индустрии до июля 2002 года.
• Уильям Гэддис, автор «J R» (1975) и «A Frolic of His Own» (1994), в течение пятнадцати лет работал техническим писателем в таких компаниях, как Pfizer и Eastman Kodak, после слабого приёма его первого романа «The Recognitions» (1955).
• Гордон Грэм, эксперт по аналитическим документам и бывший профессор письма.
• Дэн Джонс, профессор университета и член Общества технической коммуникации.
• Чак Паланик, американский автор «Бойцовского клуба», работал механиком по ремонту дизельных двигателей и техническим писателем в автомобильной промышленности до своей карьеры романиста.

См. также

• Документация на программное обеспечение
• Техническое писательство

Примечания

Литература

• Михайлов А.В. Профессия «Технический писатель», или рыцари клавиатуры (рус.). — М.: ЛЕНАНД, 2018. — 160 с. — ISBN 978-5-9710-5353-8.
• Панюкова Т.А. Документирование программного обеспечения (рус.). — М.: Книжный дом «Либроком», 2012. — 264 с. — ISBN 978-5-397-02930-8.

Ссылки

• MetaGuide — Руководство для разработчиков технической документации к программному обеспечению
• Архив EServer — Бесплатный архив для профессионалов в области документирования и коммуникаций (в частности, для технических писателей)
• Сайт технических писателей. Советы, рекомендации, форум.
• Библиотека бесплатных ГОСТов для технических писателей в открытом доступе