Профессия | |
---|---|
Синонимы | Технический корреспондент, технический редактор, составитель документации |
Произношение |
|
Сферы деятельности | Программное обеспечение, Технологии, Производство |
Описание | |
Компетенции | Аналитические навыки. Критическое мышление |
Сферы. занятости | НПО, Корпорации, Бизнес |
Связанные должности | Редактор, Спичрайтер, Сценарист, Корректор, |
A технический писатель - это профессиональный коммуникатор информации, задачей которого является передача информации между двумя или более сторонами через любой носитель, который лучше всего облегчает передача и понимание информации. Технические писатели исследуют и создают информацию с помощью различных средств доставки (электронных, печатных, аудиовизуальных и даже сенсорных). Примеры типов информации включают интерактивную справку, руководства, официальные документы, проектные спецификации, планы проектов и планы тестирования программного обеспечения. С появлением электронного обучения технические писатели все больше вовлекаются в создание онлайн-учебных материалов.
Согласно Обществу технической коммуникации (STC):
Техническое письмо иногда определяется как упрощение комплекса. Такому краткому и обманчиво простому определению присущ целый ряд навыков и характеристик, которые касаются почти каждой области человеческой деятельности на том или ином уровне. Техническое написание, являющееся значительным подмножеством более широкой области технической коммуникации, включает в себя передачу сложной информации тем, кто нуждается в ней для выполнения какой-либо задачи или цели.
Другими словами, технические писатели берут передовые технические концепции и сообщают их так ясно и точно, и в максимально возможной степени для своей целевой аудитории, обеспечивая доступность работы для пользователей.
Курт Воннегут описал технических писателей как:
... обученных не раскрывать почти ничего о себе в своих работах. Это делает их чудаками в мире писателей, поскольку почти все другие испачканные чернилами негодяи в этом мире многое рассказывают о себе читателю.
Инженеры, ученые и другие профессионалы также могут быть вовлечены в технический текст (, корректура и т. д.), но более вероятно, что они будут нанимать профессиональных технических писателей для разработки, редактирования и форматирования материалов и предоставления рекомендаций по наилучшим способам доставки информации своей аудитории.
Согласно Обществу технической коммуникации (STC), впервые упоминались профессии технического общения и технического письма около Первой мировой войны, когда техническая документация стала необходимостью в военных целях. Название должности появилось в США во время Второй мировой войны, хотя первое объявление «Требуется помощь: технический писатель» было опубликовано только в 1951 году. Фактически, титул «Технический писатель» не добавлялся в Справочник по профессиональной занятости Бюро статистики труда США до 2010 года. В 1940-х и 50-х годах были наняты технические коммуникаторы и писатели для подготовки документации для вооруженных сил, часто включающей подробные инструкции по новое вооружение. Другие технические коммуникаторы и писатели были вовлечены в разработку документации для новых технологий, которые были разработаны примерно в это время. По словам О'Хара:
Война была самым важным двигателем научно-технического прогресса. Медицинский корпус армии США боролся с малярией в джунглях Панамы, химический корпус продвигал химические достижения в области взрывчатых веществ и ядовитых газов (и средств защиты от них), инженерный корпус Манхэттенского округа буквально совершил качественный скачок в понимании физики и Авиационный корпус был пионером в области авиационного дизайна.
В начале своей профессии большинство технических писателей работали в офисе с командой других писателей. Как и современные технические писатели, они провели первичное исследование и встретились с профильными экспертами, чтобы убедиться, что их информация является точной. Во время Второй мировой войны одной из наиболее важных характеристик технических писателей была их способность соблюдать строгие государственные требования к документам. После войны появление новых технологий, таких как компьютеры, позволило техническим писателям работать в других областях, создавая «руководства пользователя, краткие справочные руководства, руководства по установке оборудования и шпаргалки». В послевоенный период (1953-1961) технические коммуникаторы (в том числе технические писатели) заинтересовались «профессионализацией» своей области. По словам Мэлоуна, технические коммуникаторы / писатели сделали это, создав профессиональные организации, взращивая «специализированный комплекс знаний» для профессии, навязывая этические стандарты техническим коммуникаторам, инициируя разговор о сертификации практикующих специалистов в этой области и работая над аккредитацией образовательных программ. в поле.
Профессия продолжала развиваться - по словам О'Хара, профессия писателя / редактора, включая технических писателей, за период с 1994 по 2005 год увеличилась на 22%. Современные технические писатели работают в разнообразие контекстов. Многие технические писатели работают удаленно, используя VPN, или общаются со своей командой через платформы видеотелефонии, такие как Skype или Zoom. Другие технические писатели работают в офисе, но делятся контентом со своей командой через сложные системы управления контентом, которые хранят документы в Интернете. Технические писатели могут работать над правительственными отчетами, внутренней документацией, инструкциями по техническому оборудованию, встроенной справкой в программном обеспечении или системах или другими техническими документами. По мере развития технологий круг возможностей для технических писателей будет расширяться. Многие технические писатели отвечают за создание технической документации для мобильных приложений или справочной документации, созданной для мобильных или веб-приложений. Они могут нести ответственность за создание контента, который будет просматриваться только на портативном устройстве; большая часть их работ никогда не будет опубликована в печатном буклете, как техническая документация прошлого.
В дополнение к серьезным исследованиям, языку, письму и редактированию технический писатель может иметь навыки в следующих областях:
Технический писатель может применить свои навыки в производстве нетехнического содержания, например, написание высокоуровневой информации для потребителей. Обычно технический писатель не является экспертом в предметной области (SME), но берет интервью у SME и проводит исследования, необходимые для написания и компиляции технически точного контента. Технические писатели проводят первичное и вторичное исследование, чтобы полностью понять тему.
Опытные технические писатели обладают способностью создавать, усваивать и передавать технические материалы кратким и эффективным образом. Они могут специализироваться в определенной области, но должны хорошо разбираться в описываемых ими продуктах. Например, составители API в основном работают с документами API, тогда как другие технические писатели специализируются на электронной коммерции, производстве, науке или медицине материал.
Технические писатели собирают информацию из многих источников. Их источники информации обычно разбросаны по всей организации, от разработчиков до отделов маркетинга.
Согласно Маркелю, полезные технические документы оцениваются по восьми характеристикам: «честность, ясность, точность, полнота, доступность, краткость, профессиональный вид и правильность». Технические писатели сосредоточены на использовании своих тщательных исследований для создания эффективных документов, соответствующих этим восьми характеристикам.
Чтобы создать эффективную техническую документацию, автор должен проанализировать три элемента, которые составляют риторическую ситуацию конкретного проекта: аудитория, цель и контекст. За ними следует дизайн документа, который определяет, что увидит читатель.
Технические писатели стремятся упростить сложные концепции или процессы, чтобы максимально улучшить понимание читателем. Конечная цель конкретного документа - помочь читателям найти то, что им нужно, понять, что они нашли, и правильно использовать то, что они понимают. Чтобы достичь этой цели, технические писатели должны понимать, как их аудитория использует и читает документацию. Анализ аудитории в начале проекта документа помогает определить, что требуется аудитории для конкретного документа.
Анализируя аудиторию, технический писатель обычно спрашивает:
Точная аудитория Анализ предоставляет набор руководящих принципов, которые определяют содержание, дизайн и представление документа (интерактивная справочная система, интерактивный веб-сайт, руководство и т. д.), а также тон и уровень знаний.
Технический писатель анализирует цель (или функцию) коммуникации, чтобы понять, что должен выполнять документ. Определение того, направлено ли сообщение на то, чтобы убедить читателей «думать или действовать определенным образом, дать им возможность выполнить задачу, помочь им понять что-то, изменить свое отношение» и т. Д., Поможет техническому писателю понять, как отформатировать свое общение, и вид коммуникации, который они выбирают (онлайн-справочная система, технический документ, предложение и т. д.).
Контекст - это физические и временные обстоятельства, в которых читатели используют общение, например: на своем рабочем столе, на производственном предприятии, в медленные летние месяцы или в середине кризис компании. Понимание контекста ситуации показывает техническому писателю, как читатели используют общение. Эти знания существенно влияют на формат общения писателя. Например, если документ представляет собой краткое руководство по устранению неполадок с элементами управления на небольшом судне, автор может ламинировать страницы для увеличения срока службы.
После того, как указанная выше информация собрана, документ разработан для оптимальной читаемости и удобства использования. По словам одного эксперта, технические писатели используют шесть дизайнерских стратегий для планирования и создания технической коммуникации: расположение, акцент, ясность, лаконичность, тон и этос.
Технические писатели обычно обладают сочетанием технических и письменных способностей. Обычно они имеют ученую степень или сертификат в технической области, но могут иметь диплом в области журналистики, бизнеса или других областях. Многие технические писатели переключаются из другой области, такой как журналистика, или из технической области, такой как инженерия или наука, часто после изучения важных дополнительных навыков на курсах технических коммуникаций.
Чтобы создать технический документ, технический писатель должен понимать предмет, цель и аудиторию. Они собирают информацию, изучая существующие материалы, опрашивая МСП и часто фактически используя продукт. Они изучают аудиторию, чтобы узнать их потребности и уровень технического понимания.
Жизненный цикл разработки технической публикации обычно состоит из пяти фаз, согласованных с общим планом разработки продукта:
Жизненный цикл разработки документа обычно состоит из шести этапов (при этом меняется организация на организацию, как они следят).
Это похоже на жизненный цикл разработки программного обеспечения.
Хорошо написанные технические документы обычно соответствуют формальным стандартам или руководствам. Техническая документация бывает разных стилей и форматов в зависимости от среды и предметной области. Печатная и электронная документация могут отличаться по-разному, но все же придерживаются в основном идентичных рекомендаций в отношении текста, структуры информации и макета. Обычно технические писатели следуют соглашениям о форматировании, описанным в стандартном руководстве по стилю . В США технические писатели обычно используют The Associated Press Stylebook или Chicago Manual of Style (CMS). Многие компании имеют внутренние руководства по корпоративному стилю, которые охватывают конкретные корпоративные вопросы, такие как использование логотипа, брендинг и другие аспекты корпоративного стиля. Типичным из них является Руководство Microsoft по стилю технических публикаций.
Инженерные проекты, особенно оборонные или связанные с аэрокосмической отраслью, часто соответствуют национальным и международным стандартам документации, таким как ATA100 для гражданских самолетов или S1000D для гражданских и оборонных платформ.
Технические писатели часто работают в составе группы написания или разработки проекта. Обычно автор завершает черновик и передает его одному или нескольким SME, которые проводят технический обзор для проверки точности и полноты. Другой писатель или редактор может выполнить редакционную проверку, которая проверяет соответствие стилям, грамматике и удобочитаемости. Этот человек может запросить разъяснения или внести предложения. В некоторых случаях автор или другие лица тестируют документ на членах аудитории, чтобы улучшить удобство использования. Окончательное производство обычно следует контрольному списку инспекций, чтобы гарантировать качество и единообразие опубликованного продукта.
Для технических писателей не существует единого стандартного пути карьеры, но они могут перейти в проект. управление над другими писателями. Писатель может перейти на должность старшего технического писателя, занимаясь сложными проектами или небольшой командой писателей и редакторов. В больших группах менеджер документации может управлять несколькими проектами и командами.
Технические писатели могут также получить опыт в определенной технической области и разветвляться в связанных формах, таких как анализ качества программного обеспечения или бизнес-анализ. Технический писатель, который становится экспертом в предметной области, может перейти от технического письма к работе в этой области. Технические писатели обычно проводят тренинги по технологиям, которые они документируют, в том числе учебные руководства и электронное обучение, а некоторые переходят к специализации в качестве профессиональных тренеров и разработчиков учебных материалов.
Технические писатели, обладающие навыками письма, могут присоединиться к печатным СМИ или компаниям электронных СМИ, потенциально предоставляя возможность заработать больше денег или улучшить условия труда.
Министерство труда США ожидает, что число технических писателей вырастет на 11 процентов с 2016 по 2026 год, что немного быстрее, чем в среднем по всем профессиям. Они ожидают, что возможности трудоустройства, особенно для соискателей с техническими навыками, будут хорошими. BLS также отметило, что распространение «научно-технических продуктов» и потребность технических писателей в «поддержке продуктов через Интернет» будет стимулировать рост спроса.
Технические писатели могут иметь различные должности, в том числе технический коммуникатор, разработчик информации, разработчик технического контента или специалист по технической документации. В Соединенном Королевстве и некоторых других странах технический писатель часто называется техническим автором или автором знаний.
Викиверситет содержит обучающие ресурсы по Техническому письму |