Техническое письмо

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

Пример «разорванной» диаграммы САПР . Взрывы с выносками — это распространенное визуальное сообщение, созданное техническими писателями для упрощения технического написания.

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

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

Однако в большинстве случаев технические тексты используются, чтобы помочь донести до конечных пользователей сложные научные или нишевые темы «непрофессиональным» языком и включают чисто фактическое содержание. Современное процедурное техническое письмо опирается на простые термины и короткие предложения, а не на подробные объяснения с ненужной информацией, такой как местоимения, абстрактные слова и незнакомые аббревиатуры. Добиться правильного тона и простоты. процессуальные документы пишутся от третьего лица, с объективной точки зрения, в формальном тоне. Этот стиль письма очень похож на стиль, используемый в печатной журналистике. Хотя техническое письмо играет важную роль в работе в области техники, здравоохранения и науки; для этого не требуется ученая степень ни в одной из этих областей. Вместо этого автор документа должен быть экспертом в области технического письма. Для обеспечения точности информации в документе используются профильные эксперты организации (SME), внутренние спецификации и формальный процесс инженерной проверки. Большинство организаций полагаются на формальное разделение труда между техническими писателями и профильными экспертами для управления технической документацией. Технические писатели сосредотачивают свою работу на формате, грамматике и стиле документации; пока инженеры и ученые проверяют точность. Большинство технических писателей имеют ученую степень в области гуманитарных писательских дисциплин, таких как: технические коммуникации, журналистика, английский язык, техническая журналистика, коммуникация и т. Д. Техническое письмо признано крупнейшим сегментом области технических коммуникаций .

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

Обзор

Дополнительная информация: Технический писатель.

Техническое письмо почти всегда выполняется обученным техническим писателем , и создаваемый им контент является частью четко определенного процесса. Технические писатели следуют строгим правилам, поэтому техническая информация, которой они делятся, представлена ​​в едином, широко используемом стандартизированном формате и стиле (например, DITA , формат уценки , AP Stylebook , Чикагское руководство по стилю ). Авторы технических статей любой организации должны быть неразличимы для читателя – без каких-либо изменений в формате, грамматике и/или стиле. Основная задача технического писателя — передать техническую информацию максимально ясным и эффективным способом. Тема, о которой рассказывает технический писатель, часто сложна, поэтому необходимы сильные письменные и коммуникативные навыки. Технические писатели не только передают информацию посредством текста, но также должны владеть новейшим графическим программным обеспечением. Технические писатели используют широкий спектр программ для создания и редактирования иллюстраций , диаграмм, расширений САПР , а также используют новейшие процессоры документов для проектирования, создания и форматирования документов.

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

История

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

Хотя техническое письмо стало профессией только после Второй мировой войны , его корни можно проследить в Древнем Египте, где для объяснения процедур регулярно использовалась визуальная коммуникация. Во времена Древней Греции и Рима техническое письмо, написанное произведениями таких писателей, как Аристотель и Демократ, считалось одними из самых ранних форм технического письма. Работа Джеффри Чосера «Трактат об астролябии » является ранним примером технического документа. Самые ранние примеры того, что можно было бы считать современным процедурным техническим письмом, относятся к ранним немецким и английским алхимикам, которые документировали свои открытия как « рецепты » еще в 1100 году нашей эры.

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

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

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

После Второй мировой войны технологический прогресс привел к увеличению потребительских товаров и уровня жизни. Во время послевоенного бума государственные услуги, такие как библиотеки и университеты, а также транспортные системы, такие как автобусы и автомагистрали, значительно выросли. Потребность писателей в хронике этих процессов возросла. Именно в этот период крупный бизнес и университеты начали использовать компьютеры. Примечательно, что в 1949 году Джозеф Д. Чаплин написал первый вычислительно-технический документ — инструкцию по эксплуатации компьютера BINAC .

Изобретение транзистора в 1947 году позволило производить компьютеры дешевле и сделать их доступными для частных лиц и малого бизнеса. По мере роста рынка этих « персональных компьютеров » росла и потребность в писателях, которые могли бы объяснить и предоставить пользовательскую документацию для этих устройств. Профессия технического писателя получила дальнейшее развитие в 1970-е и 1980-е годы, когда бытовая электроника проникала в дома все большего и большего числа людей.

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

Техническая документация

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

• Документация API используется исключительно в области веб-разработки для документирования работы и установки интерфейса прикладного программирования . Инструменты документации API включают в себя редактирование и загрузку компонентов для « Git хранилища репозитория » (например, Swagger, Postman и т. д.). Документы API обычно пишутся в стандартизированном формате « уценки ».
• Инструкции по сборке (AI) содержат пошаговые инструкции по сборке, выполняемые персоналом сборочной линии. Часто технический писатель включает в себя развертывание САПР для упрощения сложных сборок.
• Тематическое исследование — это опубликованный отчет о человеке, группе или ситуации, который изучался с течением времени; также ситуация в реальной жизни, на которую можно посмотреть или изучить, чтобы о чем-то узнать. В крупных организациях технические писатели предоставляют услуги только по редактированию или написанию текстов для тематических исследований. Авторство на уровне руководства обычно требуется для соответствия национальным стандартам и кодексам.
• В руководствах по установке (IM) используются процедуры, помогающие конечному пользователю установить продукт или программное обеспечение.
• Базы знаний или справочные центры — это сайты онлайн-справки, которые предоставляют пользователям техническую информацию о продуктах и ​​услугах. Они предоставляют контент в виде веб-страниц, которые просматриваются в браузере. Содержимое может быть создано в SGML, XML или XHTML. Компонентные системы управления контентом используются для управления этими веб-сайтами и их загрузки.
• В упаковочном листе указаны детали, упаковка и контактная информация производителя.
• Руководства пользователя (UM) или руководства по эксплуатации — это процедурные инструкции, объясняющие работу продукта или программы. Руководства пользователя написаны для широкого круга типов аудитории, в которую могут входить инженеры, ученые и/или нетехнические конечные пользователи.
• Спецификации или спецификации обычно используются в строительстве для определения минимальных стандартов и требований к установке. Спецификации обычно предоставляются застройщику руководителем проекта и должны быть подписаны и приняты строителем как часть контракта.
• Спецификация / Спецификации или Спецификации, как правило, представляют собой одностраничные справочные листы, предназначенные для предоставления списка общих характеристик продукта, которые могут потребоваться конечному пользователю для совершения покупки. Примеры технических характеристик: максимальные и минимальные параметры, размер и занимаемая площадь, вес, тип соединения или интерфейсы, электрические требования, скорость и т. д.
• Стандартные операционные процедуры (СОП) — это процедурные действия, выполняемые военными, производственными, медицинскими работниками и специалистами по промышленной безопасности для выполнения заказанных повседневных задач или выполнения установленных действий любого рода в надлежащем порядке.
• Технический контент — это информация, обычно написанная для маркетинговых целей. Технический контент часто используется для описания информации о продукте и его характеристик в торговых листах и ​​на веб-сайтах.
• Официальные документы — это маркетинговые документы, часто написанные техническими писателями и приписываемые экспертам в данной области. Все они носят убедительный характер и представляют собой аргументы, рекламирующие преимущества или решения продукта.

Инструменты

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

• Настольные издательские инструменты или текстовые процессоры . В 1990-е годы большая часть технических работ выполнялась с помощью таких инструментов, как Microsoft Word , PageMaker или Framemaker . Эти ранние программы позволяли техническим писателям создавать, редактировать, проектировать и печатать документы с компьютера. Авторы официальных документов, как правило, по-прежнему полагаются на Microsoft Word и расширенные инструменты настольных издательских систем, такие как Adobe InDesign и LyX, для настольных издательских систем.
• Системы управления контентом (CMS) и системы управления компонентным контентом (CCMS) . Современные инструменты редактирования и хранения технических текстов, такие как CMS, используются организациями для редактирования, хранения и публикации справочных систем «базы знаний» в Интернете. Помимо базовых функций редактирования и вывода в Интернет, CMS также предоставляют функции управления контентом, такие как управление версиями и встроенные рабочие процессы. Большинство CMS основаны на SGML , XML или XHTML .
• Программное обеспечение для редактирования изображений . Часто изображения и другие визуальные элементы могут передавать информацию лучше, чем абзацы текста. В этих случаях технические писатели используют программное обеспечение для редактирования изображений, такое как Adobe Photoshop, Illustrator, Visio и Corel Draw, для создания и редактирования визуальных аспектов документов, таких как фотографии, значки и диаграммы.
• Программы для совместной работы. Поскольку техническое написание часто предполагает общение между несколькими людьми, работающими в разных компаниях, оно может быть совместным делом. Технические писатели используют Wiki-системы, такие как Confluence , и общие рабочие пространства для документов, чтобы работать с другими авторами и сторонами над созданием технических документов.
• Инструменты веб-разработки . Работа технического писателя больше не ограничивается только созданием документов. Иногда они также создают контент для корпоративных и других профессиональных веб-сайтов компании. Поэтому от технических писателей можно ожидать, что они будут владеть HTML/CSS и соответствующими инструментами веб-публикации, такими как MadCap Flare , oXygen или ArborText.
• Графическое программное обеспечение. Чтобы передать статистическую информацию, такую ​​как количество посещений ресторана или сумму денег, которую университет тратит на свои спортивные программы, технические писатели используют графики и блок-схемы. Хотя такие программы, как Microsoft Excel и Word, могут создавать простые графики и диаграммы, иногда техническим писателям приходится создавать более сложные и подробные графики, для которых требуются функции, недоступные в этих программах, и, возможно, придется обратиться к инструментам построения графиков и диаграмм (например, Microsoft Visio ), Tableau , Power-BI и т. д.
• Инструменты захвата экрана. Технические писатели часто используют инструменты для захвата экрана, такие как Camtasia и Snagit . При создании инструкций для компьютерного программного обеспечения техническому писателю может быть проще просто записать короткое видео о своих рабочих столах во время выполнения задачи, чем писать длинную серию инструкций, описывающих, как должна выполняться задача. Инструменты захвата экрана также используются для создания снимков экрана программ и программного обеспечения, работающих на компьютерах пользователей, а затем для создания сопроводительных диаграмм.

Список ассоциаций

• Ассоциация делового общения
• Чешское общество технической связи
• Европейская ассоциация технических коммуникаций
• Общество профессиональных коммуникаций IEEE
• Институт научно-технических коммуникаторов
• Международная ассоциация бизнес-коммуникаторов
• СИГДОК
• Общество технической связи

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

• Техническое письмо в Curlie
• Программы обучения техническому письму - Лос-Анджелесское отделение Общества технических коммуникаций (LASTC)
• Транзакции IEEE по профессиональному общению
• Курсы технического письма от Викиверситета