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

Технический писатель является профессиональной информации коммуникатором, задача которого заключается в передаче информации между двумя или более сторонами, с помощью любых средств , которые наилучшим образом облегчает передачу и понимание информации. Технические писатели исследуют и создают информацию с помощью различных средств доставки (электронных, печатных, аудиовизуальных и даже сенсорных). ^[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 или Zoom . Другие технические писатели работают в офисе, но делятся контентом со своей командой через сложные системы управления контентом.которые хранят документы в Интернете. Технические писатели могут работать над правительственными отчетами, внутренней документацией, инструкциями по техническому оборудованию, встроенной справкой в ​​программном обеспечении или системах или другими техническими документами. По мере развития технологий круг возможностей для технических писателей будет расширяться. Многие технические писатели отвечают за создание технической документации для мобильных приложений или справочной документации, созданной в мобильных или веб-приложениях. Они могут нести ответственность за создание контента, который будет просматриваться только на портативном устройстве; большая часть их работ никогда не будет опубликована в печатном буклете, как техническая документация прошлого.

Набор навыков [ править ]

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

Технический писатель может применить свои навыки при создании нетехнического контента, например, для написания информации для потребителей высокого уровня . Обычно технический писатель не является экспертом в предметной области (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. Форматирование и публикация (опубликовать документ).

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

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

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

Окружающая среда [ править ]

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

Карьерный рост [ править ]

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

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

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

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

Известные технические писатели [ править ]

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

Похожие названия [ править ]

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

См. Также [ править ]

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

Ссылки [ править ]

Внешние ссылки [ править ]

В Викиверситете есть учебные ресурсы о техническом письме

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