Техническое письмо — это специализированная форма общения, используемая многими современными промышленными и научными организациями для четкой и точной передачи сложной информации пользователю. Клиенты, сотрудники, сборщики, инженеры и ученые организации — одни из наиболее распространенных пользователей, которые обращаются к этой форме контента для выполнения задачи или исследования предмета. Большая часть технического письма опирается на упрощенную грамматику, подкрепленную простой для понимания визуальной коммуникацией для четкого и точного объяснения сложной информации.
Техническое письмо — это трудоемкая форма письма, которая требует точного исследования предмета и преобразования собранной информации в письменный формат, стиль и уровень чтения, которые конечный пользователь легко поймет или с которыми свяжется. Существует две основные формы технического письма. Безусловно, наиболее распространенной формой технического письма является процедурная документация, написанная для широкой публики (например, стандартизированные пошаговые руководства и стандартные рабочие процедуры (СОП)). Процедурное техническое письмо используется во всех типах производства для объяснения операций пользователя, сборки, инструкций по установке и шагов по работе/безопасности персонала. Письменные процедуры широко используются в производстве, разработке программного обеспечения, медицинских исследованиях и многих других научных областях. Индустрия программного обеспечения превратилась в одного из крупнейших пользователей технического письма и полагается на процедурные документы для описания операций пользователя и инструкций по установке программы.
В некоторых приложениях техническое письмо может быть написано для экспертов или коллег-ученых в области работы или учебы. В этих приложениях форма технического письма «white paper» используется для описания специализированной темы и продвижения продукта/услуги или мнения/открытия для избранных читателей. Организации обычно используют форму white paper для публикации технического письма в виде статей в отраслевых журналах или научных работ. Форма white paper написана для обращения к читателям, знакомым с технической темой. В отличие от процедурного технического письма, white paper часто включают уникальные отраслевые термины и данные. Иногда называемая научным техническим письмом , эта вторичная форма технического письма должна демонстрировать глубокое знание предмета и области работы с единственной целью — убедить читателей согласиться с выводом статьи. [1] Эта форма технического письма часто пишется техническим писателем-призраком . Технический писатель будет тесно сотрудничать с отраслевым экспертом организации для написания этих документов, но редко упоминается в опубликованной версии.
Однако в большинстве случаев техническое письмо используется для того, чтобы помочь донести сложные научные или узкоспециализированные темы до конечных пользователей в терминах «неспециалистов» и включает в себя исключительно фактическое содержание. Современное процедурное техническое письмо опирается на простые термины и короткие предложения, а не на подробные объяснения с ненужной информацией, такой как личные местоимения, абстрактные слова и незнакомые аббревиатуры. Чтобы добиться правильной грамматики, процедурные документы пишутся от третьего лица, объективной точки зрения, с активным залогом и формальным тоном. Более полное описание стиля технического письма дано в книге Странка и Уайта « Элементы стиля» . Грамматика технического письма очень похожа на печатную журналистику и следует тому же стилю. [2] Хотя техническое письмо играет неотъемлемую роль в работе инженерии, здравоохранения и науки, оно не требует ученой степени ни в одной из этих областей. Вместо этого автор документа должен быть экспертом в техническом письме. Для обеспечения точности полагаются на экспертов по предметной области (SME) организации, внутренние спецификации и формальный процесс инженерного обзора. Разделение труда помогает лучше сфокусироваться на двух сторонах документации организации, обеспечивая большую точность и качество. Большинство технических писателей имеют степень гуманитарного факультета в области письма, например, техническая коммуникация, журналистика, английский язык, техническая журналистика, коммуникация и т. д. Техническое письмо является крупнейшим сегментом области технической коммуникации . [3]
Примерами областей, требующих технического письма, являются компьютерное оборудование и программное обеспечение , архитектура , машиностроение , химия , аэронавтика , робототехника , производство , финансы , медицина , патентное право , бытовая электроника , биотехнологии и лесное хозяйство .
Техническое письмо чаще всего выполняется обученным техническим писателем , и контент, который они создают, является результатом четко определенного процесса. Технические писатели следуют строгим правилам, поэтому техническая информация, которой они делятся, представлена в едином, популярном и стандартизированном формате и стиле (например, DITA , формат markdown , AP Stylebook , Chicago Manual of Style ). Основная задача технического писателя — донести техническую информацию максимально понятным и эффективным способом. [4] : 4 [5] Чтобы достичь наивысшего уровня ясности, авторы технического письма организации должны быть неотличимы для читателя — без изменений в установленном формате, грамматике и/или стиле. Тема, которую передает технический писатель, часто сложна, поэтому необходимы сильные навыки письма и общения. Технические писатели не только передают информацию посредством текста, но и должны владеть новейшим графическим программным обеспечением. Технические писатели используют широкий спектр программ для создания и редактирования иллюстраций , диаграмм и взрывов САПР . Владение новейшим графическим программным обеспечением является обязательным требованием для большинства технических писем. [6]
В некоторых случаях инженеры могут выполнять техническое письмо для проекта, над которым они работают, но это редко происходит в крупных организациях, где продукты должны выпускаться или пересматриваться еженедельно. С деловой стороны, маркетинговые материалы или пресс-релизы обычно пишутся писателями, прошедшими обучение в области маркетинга и/или творческого письма. Однако технический писатель может рассчитывать на редактирование и другие данные по любому техническому контенту, который может быть создан организацией.
Хотя техническое письмо было признано как профессия только после Второй мировой войны , его корни можно проследить до Древнего Египта, где визуальная коммуникация регулярно использовалась для объяснения процедур. В древнегреческие и древнеримские времена техническое письмо в работах таких писателей, как Аристотель и Демократ, упоминается как одна из самых ранних форм письменного технического письма. Самые ранние примеры того, что можно считать современным процедурным техническим письмом, относятся к ранним алхимикам . Эти ранние ученые разработали то, что мы теперь знаем как « рецепты ». Некоторые из самых ранних открытий письменных, процедурных шагов в Западной цивилизации относятся к 1100 году н. э. Однако визуальная коммуникация использовалась для описания процедур в древней Индии и Китае гораздо раньше.
С изобретением механического печатного станка , началом эпохи Возрождения и подъемом Века Разума документирование открытий стало необходимостью. Изобретатели и ученые, такие как Исаак Ньютон и Леонардо да Винчи, подготовили документы, в которых фиксировались их изобретения и открытия. [7] : 1 Хотя эти документы никогда не назывались техническими документами в период их публикации, они сыграли решающую роль в развитии современных форм технической коммуникации и письма. [7]
Область технической коммуникации развивалась во время промышленной революции . [8] : 3 Растет потребность в предоставлении людям инструкций по использованию все более сложных машин, которые изобретались. [8] : 8 Однако, в отличие от прошлого, где навыки передавались устно, никто, кроме изобретателей, не знал, как использовать эти новые устройства. Таким образом, письмо стало самым быстрым и эффективным способом распространения информации, и писатели, которые могли бы документировать эти устройства, были востребованы. [8]
В 20 веке потребность в техническом письме резко возросла, и профессия была официально признана. События Первой и Второй мировых войн привели к прогрессу в медицине, военной технике, компьютерных технологиях и аэрокосмических технологиях. [7] : 2 Этот быстрый рост в сочетании с срочностью войны создал немедленную потребность в хорошо разработанной документации для поддержки использования этих технологий. Техническое письмо пользовалось большим спросом в это время, и «технический писатель» стал официальным названием должности во время Второй мировой войны. [7] : 1
После Второй мировой войны технический прогресс привел к росту потребительских товаров и повышению уровня жизни. [7] : 3 Во время послевоенного бума государственные службы, такие как библиотеки и университеты, а также транспортные системы, такие как автобусы и автомагистрали, значительно выросли. Потребность в писателях, которые могли бы описывать эти процессы, возросла. [7] : 1 Также в этот период крупный бизнес и университеты начали использовать компьютеры. Примечательно, что в 1949 году Джозеф Д. Чаплин написал первый вычислительный технический документ — руководство по эксплуатации для компьютера BINAC . [9]
Изобретение транзистора в 1947 году позволило производить компьютеры дешевле и сделать их доступными для частных лиц и малого бизнеса. [7] : 3 По мере роста рынка этих « персональных компьютеров » росла и потребность в писателях, которые могли бы объяснять и предоставлять пользовательскую документацию для этих устройств. [7] : 3 Профессия технического писателя получила дальнейшее развитие в 1970-х и 1980-х годах, когда бытовая электроника проникала в дома все большего числа людей. [7]
В последние годы значимость компьютеров в обществе привела ко многим достижениям в области цифровых коммуникаций, что привело к изменениям в инструментах, используемых техническими писателями. [7] : 3 Гипертекст , текстовые процессоры , программы редактирования графики и программное обеспечение для верстки страниц ускорили и упростили создание технических документов, и сегодня технические писатели должны владеть этими программами на профессиональном уровне. [4] : 8–9
Техническое письмо охватывает множество жанров и стилей письма, в зависимости от информации и аудитории. Некоторые примеры часто используемой технической документации включают:
Технические писатели используют следующие инструменты для создания и представления документов: