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

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

Согласно Общество технической коммуникации (STC):^[2]

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

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

Курт Воннегут описал технических писателей как:^[3]

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

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

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

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

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

В начале своей профессии большинство технических писателей работали в офисе с командой других писателей. Как и современные технические писатели, они провели первичное исследование и встретились с профильными экспертами, чтобы убедиться, что их информация является точной. Во время Второй мировой войны одной из наиболее важных характеристик технических писателей была их способность соблюдать строгие государственные требования к документам.^[9] После войны появление новых технологий, таких как компьютеры, позволило техническим писателям работать в других областях, создавая^[10] «Руководства пользователя, краткие справочные руководства, руководства по установке оборудования и шпаргалки». В послевоенный период (1953-1961) технические коммуникаторы (в том числе технические писатели) заинтересовались «профессионализацией» своей области.^[11] По словам Мэлоуна,^[12] технические коммуникаторы / писатели добивались этого, создавая профессиональные организации, развивая «специализированный комплекс знаний» для этой профессии, навязывая этические стандарты техническим коммуникаторам, инициируя разговор о сертификации практикующих специалистов в этой области и работая над аккредитацией образовательных программ в этой области.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Цель

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

Контекст

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

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

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

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

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

Акцент

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

Ясность

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

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

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

Тон

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

Этос

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

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

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

Методология (жизненный цикл разработки документа)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Министерство труда США ожидает, что занятость технических писателей вырастет на 11 процентов с 2016 по 2026 год, что немного быстрее, чем в среднем по всем профессиям. Они ожидают, что возможности трудоустройства, особенно для соискателей с техническими навыками, будут хорошими. BLS также отметила, что распространение «научно-технических продуктов» и потребность технических писателей в «поддержке продуктов через Интернет» будет стимулировать рост спроса.^[21]

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

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

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

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

Смотрите также

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

использованная литература

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

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