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

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

Занятие
Синонимы	Технический корреспондент, Технический редактор, Автор документации, Медицинский писатель, Технический журналист
Секторы деятельности	Программное обеспечение , Технологии , Производство , Медицина
Описание
Компетенции	Аналитические навыки Критическое мышление , AP или CMOS , стиль Грамматика третьего лица, Процедурное форматирование (DITA)
Области работа	НПО , Корпорации , Бизнес
Похожие вакансии	Редактор , Спичрайтер , Сценарист , Корректор , Копи-редактор

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

По данным Общества технических коммуникаций (STC):

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

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

Курт Воннегут описывал технических писателей как:

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

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

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

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

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

С самого начала своей профессии технические писатели работали в командах с другими техническими писателями. По сей день большинство организаций по-прежнему нанимают команду для написания и редактирования технических текстов для назначенного продукта или услуги. Будучи членом команды, технические писатели работают независимо, исследуя свои задания. Регулярные встречи один на один с профильными экспертами (SME) и ссылки на внутренние исследования (например, механические чертежи, спецификации, спецификации, таблицы данных и т. д.) предоставляют техническому писателю необходимые проверки для обеспечения точности документа. После того как точность документа проверена и одобрена назначенным МСП, технические писатели полагаются на свою команду авторов, которая предоставит экспертную оценку. Рецензирование фокусируется исключительно на формате контента, стиле и стандартизации грамматики. Цель экспертной оценки команды — обеспечить, чтобы технические материалы организации «говорили одним голосом».

Во время Второй мировой войны одной из наиболее важных характеристик технических писателей была их способность следовать строгим государственным требованиям к документам. После войны появление новых технологий, таких как компьютеры, позволило техническим писателям работать в других областях, создавая «руководства пользователя, краткие справочные руководства, руководства по установке оборудования и шпаргалки». После войны (1953–1961) технические коммуникаторы (в том числе технические писатели) заинтересовались «профессионализацией» своей области. По словам Мэлоуна, технические коммуникаторы/писатели сделали это, создав профессиональные организации, культивируя «специализированную совокупность знаний» для профессии, навязывая этические стандарты техническим коммуникаторам, инициируя разговор о сертификации практиков в этой области и работая над аккредитацией образовательных программ в этой области.

Профессия продолжала расти - по словам О'Хары, количество должностей в писательской/редактической профессии, включая технических писателей, увеличилось на 22% в период с 1994 по 2005 год. Современные технические писатели работают в самых разных контекстах. Многие технические писатели работают удаленно, используя VPN , или общаются со своей командой через платформы видеотелефонии , такие как Skype или Zoom . Другие технические писатели работают в офисе, но делятся контентом со своей командой через сложные системы управления контентом , которые хранят документы в Интернете. Технические писатели могут работать над правительственными отчетами, внутренней документацией, инструкциями для технического оборудования, встроенной справкой в ​​программное обеспечение или системы или другими техническими документами. Поскольку технологии продолжают развиваться, спектр возможностей для технических писателей будет продолжать расширяться. Многие технические писатели отвечают за создание технической документации для мобильных приложений или справочной документации, встроенной в мобильные или веб-приложения. Они могут нести ответственность за создание контента, который можно будет просматривать только на портативных устройствах; большая часть их работ никогда не будет опубликована в виде печатного буклета, как техническая документация прошлого.

Технические писатели и UX-дизайнеры

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

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

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

Как объясняет Редиш, специалист по техническим коммуникациям больше не пишет контент, а сам «пишет вокруг интерфейса» по мере развития пользовательского опыта, связанного с контентом. Сюда входит полезный контент, адаптированный к конкретным потребностям пользователя, который учитывает эмоции, чувства и мысли пользователя по разным каналам в среде UX.

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

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

Набор навыков

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

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

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

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

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

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

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

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

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

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

Основная статья: Анализ аудитории

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

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

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

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

Цель

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

Контекст

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

Оформление документа

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

Договоренность

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

Акцент

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

Ясность

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

Лаконичность

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

Тон

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

этос

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

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

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

(жизненный цикл разработки

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

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

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

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

1. Профилирование аудитории (определить целевую аудиторию)
2. Анализ пользовательских задач (анализ задач и информации исходя из целевой аудитории)
3. Информационная архитектура (проектирование на основе анализа, как подготовить документ)
4. Разработка контента (разработать/подготовить документ)
5. Технические и редакционные обзоры (обзор с участием персонала более высокого уровня — менеджеров и т. д.)
6. Форматирование и публикация (опубликовать документ).

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

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

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

Окружающая среда

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

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

пандемии COVID-

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

Карьерный рост

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

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

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

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

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

технические

• Тед Чан , американский автор рассказов, в том числе «История вашей жизни » (1998) и «Купец и ворота алхимика» (2007), еще в июле 2002 года был техническим писателем в индустрии программного обеспечения.
• Уильям Гэддис , автор книг «JR» (1975) и «Его собственные развлечения» (1994), полтора десятилетия работал техническим писателем в таких компаниях, как Pfizer и Eastman Kodak, после плохого приема его первого романа «Признания». (1955).
• Гордон Грэм , эксперт по официальным документам и бывший профессор писательского мастерства.
• Дэн Джонс , профессор университета и член Общества технических коммуникаций .
• Чак Паланик , американский автор « Бойцовского клуба» , работал механиком по дизельным двигателям и автомобильным техническим писателем. до своей карьеры писателя
• Роберт М. Пирсиг , автор книги «Дзен и искусство обслуживания мотоциклов: исследование ценностей» (ZAMM) (1974), писал технические руководства для IBM, работая над бестселлером.
• Томас Пинчон , американский автор книг «Плач лота 49» (1966), «Радуга гравитации» (1973) и «Мейсон и Диксон» (1997), среди других, написал свой первый роман «В.» (1963), работая техническим писателем для Боинг с 1960 по 1963 год.
• Джордж Сондерс , американский автор книги «Десятое декабря: Истории» (2013), а также других сборников рассказов, эссе и новелл, написал свой первый сборник рассказов « CivilWarLand in Bad Decline » (1996), работая техническим писателем и геофизиком. инженер Radian International, экологической инженерной фирмы в Рочестере, Нью-Йорк .
• Эми Тан , американский автор романов «Клуб радости и удачи» (1998), «Дочь костоправа» (2001) и других романов, получивших признание критиков. Тан начала писать художественные романы, когда была техническим писателем.
• Ричард Уилбур , американский поэт. Как он упомянул в разговоре, работал в Боинге.
• Мэрион Виник , американский писатель и эссеист, работала техническим писателем в 1984–1994 годах в Unison-Tymlabs, Остин, Техас.

Похожие названия

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

• Технический коммуникатор
• Технический автор
• Технический писатель
• Разработчик технического контента
• Разработчик контента
• Контент-дизайнер
• Разработчик технической информации
• Информационный архитектор
• Информационный инженер
• Информационный дизайнер
• Информационный разработчик
• Специалист по документации
• Специалист по документообороту
• Менеджер по документации
• Текстовый инженер

См. также

• Совместное редактирование
• Европейская ассоциация технических коммуникаций
• Документация по программному обеспечению

Внешние ссылки

• СМИ, связанные с техническими писателями, на Викискладе?
• Описания и ссылки на стандарты для технических писателей
• Программы обучения техническому письму - Лос-Анджелесское отделение Общества технических коммуникаций (LASTC)
• ISO/IEC JTC 1/SC 7 ISO/IEC JTC 1/SC 7 — Рабочая группа 2 разрабатывает международные стандарты документации программного обеспечения