Тип письменного общения
Техническое письмо — это написание технического контента, особенно касающегося промышленных и других прикладных наук , с упором на профессиональный контекст. [1] Диапазон аудитории технических писаний широко варьируется. Безусловно, наиболее распространенной формой технического письма является процедурная документация (стандартизированные пошаговые руководства). Методическая документация используется на всех видах производства для пояснения инструкций по эксплуатации, сборке и установке. В индустрии программного обеспечения процедурные документы также часто используются для описания пользовательских операций и установок. В некоторых случаях технические статьи могут быть написаны для экспертов или технических специалистов и включать специализированную информацию (например, официальные документы, отраслевые статьи и научные статьи). [2] Однако в большинстве случаев технические писатели помогают донести до конечных пользователей сложные научные или нишевые темы «непрофессиональным» языком. Современное техническое письмо опирается на простые термины и короткие предложения, а не на подробные объяснения с ненужной информацией, такой как местоимения, абстрактные слова и/или незнакомые аббревиатуры. [3] Техническое письмо признано крупнейшим сегментом области технических коммуникаций . [4]
Примеры областей, требующих технического письма, включают компьютерное оборудование и программное обеспечение , архитектуру , инженерию , химию , аэронавтику , робототехнику , финансы , медицину , бытовую электронику , биотехнологию и лесное хозяйство .
Обзор
Техническое письмо почти всегда выполняется обученным техническим писателем , и создаваемый им контент является частью четко определенного процесса. Технические писатели следуют строгим правилам, поэтому техническая информация, которой они делятся, представлена в едином, широко используемом стандартизированном формате и стиле (например, DITA , AP Stylebook , Chicago Manual of Style ). Авторы технических статей любой организации должны быть неотличимы для читателя – без различий в использовании грамматики и/или стиле. Основная задача технического писателя — передать техническую информацию другому лицу или стороне максимально ясным и эффективным способом. [5] : 4 [6] Информация, которую передают технические писатели, часто сложна, поэтому необходимы сильные письменные и коммуникативные навыки. Технические писатели не только передают информацию посредством текста, но также должны владеть компьютером. Технические писатели используют широкий спектр программ для создания и редактирования иллюстраций , диаграмм, расширений САПР , а также используют новейшие процессоры документов для проектирования, создания и форматирования документов. [7]
Хотя техническое письмо обычно ассоциируется с инструкциями и руководствами пользователя , термины «техническое письмо» и «техническая документация» могут охватывать более широкий спектр жанров и форматов. памятки , отчеты , деловые предложения , технические описания , описания и спецификации продуктов , а также официальные документы — это лишь несколько примеров письменной речи, которую можно считать технической документацией. [8]
Техническим письмом не всегда занимаются преданные своему делу технические писатели. Инженеры иногда пишут о своей работе, но на крупных предприятиях такое случается редко. Что касается бизнеса, маркетинговые материалы или пресс-релизы обычно пишутся авторами, прошедшими обучение в области маркетинга, хотя можно полагаться на технического писателя, который обеспечит редактирование и другой вклад в любой технический контент, который может создавать организация.
История
Хотя техническое письмо было признано профессией только после Второй мировой войны , [9] : 2 [10] его корни можно проследить до классической античности . [11] : 233 Критики называют произведения таких писателей, как Аристотель , самыми ранними формами технического письма. [11] : 234 Работа Джеффри Чосера « Трактат об астролябии » является ранним примером технического документа . [12] Самые ранние примеры технического письма относятся к древнеанглийскому периоду. [13]
С изобретением механического печатного станка , наступлением эпохи Возрождения и эпохой разума документирование результатов стало необходимостью. Изобретатели и ученые, такие как Исаак Ньютон и Леонардо да Винчи, подготовили документы, в которых описывались их изобретения и открытия. [9] : 1 Хотя эти документы никогда не назывались техническими документами в период их публикации, они сыграли решающую роль в развитии современных форм технической коммуникации и письма. [9]
Область технических коммуникаций выросла во время промышленной революции . [14] : 3 Растула потребность в предоставлении людям инструкций по использованию все более сложных машин, которые изобретались. [14] : 8 Однако, в отличие от прошлого, когда навыки передавались через устные традиции, никто, кроме изобретателей, не знал, как использовать эти новые устройства. Таким образом, письмо стало самым быстрым и эффективным способом распространения информации, и писатели, которые могли документировать эти устройства, были желательны. [14]
В течение 20-го века потребность в технической литературе резко возросла, и эта профессия получила официальное признание. События Первой и Второй мировых войн привели к развитию медицины, военной техники, компьютерных и аэрокосмических технологий. [9] : 2 Этот быстрый рост в сочетании с неотложностью войны создал острую потребность в хорошо продуманной документации для поддержки использования этих технологий. В то время техническое письмо пользовалось большим спросом, и во время Второй мировой войны «технический писатель» стал официальным названием должности. [9] : 1
После Второй мировой войны технологический прогресс привел к увеличению потребительских товаров и уровня жизни. [9] : 3 Во время послевоенного бума государственные услуги, такие как библиотеки и университеты, а также транспортные системы, такие как автобусы и автомагистрали, значительно выросли. Потребность писателей в хронике этих процессов возросла. [9] : 1 Именно в этот период крупный бизнес и университеты начали использовать компьютеры. Примечательно, что в 1949 году Джозеф Д. Чаплин написал первый вычислительно-технический документ — инструкцию по эксплуатации компьютера BINAC . [15]
Изобретение транзистора в 1947 году позволило производить компьютеры дешевле и сделать их доступными для частных лиц и малого бизнеса. [9] : 3 По мере роста рынка этих « персональных компьютеров » росла и потребность в писателях, которые могли бы объяснить и предоставить пользовательскую документацию для этих устройств. [9] : 3 Профессия технического писателя получила дальнейшее развитие в 1970-х и 1980-х годах, когда бытовая электроника проникла в дома все большего и большего числа людей. [9]
В последние годы известность компьютеров в обществе привела ко многим достижениям в области цифровых коммуникаций, что привело к изменениям в инструментах, используемых техническими писателями. [9] : 3 Гипертекст , текстовые процессоры , программы графического редактирования и программное обеспечение для верстки страниц сделали создание технических документов быстрее и проще, и современные технические писатели должны владеть этими программами. [5] : 8–9
Техническая документация
Техническое письмо охватывает множество жанров и стилей письма, в зависимости от информации и аудитории. Некоторые примеры часто используемой технической документации включают в себя:
- Руководства по API написаны для сообщества разработчиков программного обеспечения и используются для объяснения интерфейса прикладного программирования .
- Инструкции по сборке (AI) содержат пошаговые инструкции по сборке, выполняемые персоналом сборочной линии. Часто технический писатель включает в себя развертывание САПР для упрощения сложных сборок.
- Тематическое исследование — это опубликованный отчет о человеке, группе или ситуации, который изучался с течением времени; также ситуация в реальной жизни, на которую можно посмотреть или изучить, чтобы о чем-то узнать. [16] Например, в качестве примера можно привести сложную ситуацию, сложившуюся у человека на рабочем месте, и то, как он или она ее разрешил.
- В руководствах по установке (IM) используются процедуры, помогающие конечному пользователю установить продукт или программное обеспечение.
- Базы знаний или справочные центры — это сайты онлайн-справки, которые предоставляют пользователям техническую информацию о продуктах и услугах. Они предоставляют контент в виде веб-страниц, которые просматриваются в браузере. Контент может быть создан в системе управления контентом компонента XML CCMS с выводом в формате HTML/PDF.
- В упаковочном листе указаны детали, упаковка и контактная информация производителя.
- Руководства пользователя (UM) или руководства по эксплуатации — это процедурные инструкции, объясняющие работу продукта или программы. Руководства пользователя написаны для широкого круга типов аудитории, в которую могут входить инженеры, ученые и/или нетехнические конечные пользователи.
- Спецификации или спецификации обычно используются в строительстве для определения минимальных стандартов и требований к установке. Спецификации обычно предоставляются застройщику руководителем проекта и должны быть подписаны и приняты строителем как часть контракта.
- Спецификации , или Спецификации , или Таблицы данных, как правило, представляют собой одностраничные справочные листы, предназначенные для предоставления списка общих характеристик продукта, которые могут потребоваться конечному пользователю для совершения покупки. Примеры технических характеристик: максимальные и минимальные параметры, размер и занимаемая площадь, вес, тип соединения или интерфейсы, электрические требования, скорость и т. д.
- Стандартные операционные процедуры (СОП) — это процедурные действия, необходимые военному, производственному, медицинскому персоналу и персоналу службы промышленной безопасности для выполнения заказанных повседневных задач или выполнения установленных действий любого рода в надлежащем порядке.
- Технический контент — это информация, обычно написанная для маркетинговых целей. Технический контент часто используется для описания информации о продукте и его характеристик в торговых листах и на веб-сайтах.
- Официальные документы — это маркетинговые документы, часто написанные техническими писателями и приписываемые экспертам в данной области. Все они носят убедительный характер и представляют собой аргументы, рекламирующие преимущества или решения продукта.
Инструменты
Следующие инструменты используются техническими писателями для создания и представления документов:
- Настольные издательские инструменты или текстовые процессоры . Технические писатели используют текстовые процессоры, такие как Scrivener, Microsoft Word , Apple Pages и LibreOffice Writer, для создания, редактирования, дизайна и печати документов. Поскольку техническое письмо связано не только с письменным языком, но и с макетом страницы,также используются расширенные инструменты настольной издательской системы, такие как Adobe InDesign и LyX . [17] Эти программы функционируют аналогично текстовым процессорам, но предоставляют пользователям больше возможностей и возможностей для оформления документа и автоматизируют большую часть форматирования. [18]
- Помощь в создании инструментов . Они используются техническими писателями для создания справочных систем, которые входят в состав программных продуктов, доставляются через веб-браузеры или предоставляются в виде файлов, которые пользователи могут просматривать на своих компьютерах. При написании инструкций по описанию механических, электрических или программных программ технические писатели используют эти инструменты, чтобы упростить процессы сборки, эксплуатации или установки.
- Компоненты систем управления контентом . Они также используются техническими писателями для создания справочных систем и документов. Компонентные системы управления контентом (CCMS) позволяют авторам создавать результаты, аналогичные вспомогательным инструментам разработки, но они также предоставляют функции управления контентом, такие как управление версиями и встроенные рабочие процессы.
- Программное обеспечение для редактирования изображений . Часто изображения и другие визуальные элементы могут передавать информацию лучше, чем абзацы текста. [5] : 306–307 В таких случаях технические писатели используют программное обеспечение для редактирования изображений, такое как Adobe Photoshop и GIMP, для создания и редактирования визуальных аспектов документов, таких как фотографии, значки и диаграммы.
- Программы для совместной работы. Поскольку техническое написание часто предполагает общение между несколькими людьми, работающими в разных компаниях, оно может быть совместным делом. [5] : 57 Технические писатели используют Wiki-системы и общие рабочие пространства для документов для работы с другими авторами и сторонами над созданием технических документов. [5] : 74
- Инструменты веб-разработки . Работа технического писателя больше не ограничивается только созданием документов. Иногда они также создают контент для корпоративных и других профессиональных веб-сайтов компании. Поэтому можно ожидать, что технические писатели будут владеть инструментами HTML/CSS и CMS, такими как MadCap Flare , oXygen или Framemaker .
- Текстовые редакторы . Такие программы, как Microsoft Notepad , TextEdit или Wordstar, позволяют техническим писателям редактировать простой текст . Текстовые редакторы можно использовать для изменения содержимого, такого как файлы конфигурации , файлы документации и исходный код языка программирования . Текстовые редакторы широко используются техническими писателями, работающими с онлайн-контентом.
- Графическое программное обеспечение. Чтобы передать статистическую информацию, такую как количество посещений ресторана или сумму денег, которую университет тратит на свои спортивные программы, технические писатели используют графики и блок-схемы. [5] : 306–307 Хотя такие программы, как Microsoft Excel и Word, могут создавать простые графики и диаграммы, иногда техническим писателям приходится создавать более сложные и подробные графики, для которых требуются функции, недоступные в этих программах, и, возможно, придется обратиться к инструментам построения графиков и диаграмм ( например, Microsoft Visio ). [19]
- Инструменты захвата экрана. Технические писатели часто используют инструменты для захвата экрана, такие как Camtasia и Snagit . [20] [21] При создании инструкций для компьютерного программного обеспечения техническому писателю может быть проще просто записать короткое видео о своих рабочих столах во время выполнения задачи, чем написать длинную серию инструкций, описывающих, как задание должно быть выполнено. Инструменты захвата экрана также используются для создания снимков экрана программ и программного обеспечения, работающих на компьютерах пользователей, а затем для создания сопроводительных диаграмм.
Список ассоциаций
Рекомендации
- ^ «Что такое техническое письмо? - Технический писатель сегодня» .
- ^ Хэмлин, Аннемари; Рубио, Крис; Десильва, Мишель (2015). «Анализ аудитории».
- ^ Маршалл, Кэрри (2018). Техническое письмо для деловых людей (1-е изд.). Суиндон Великобритания. п. 1.
- ^ «Технические коммуникации - что это? - Технический писатель сегодня» .
- ^ abcdef Майк Маркел (2012). Технические коммуникации, 10-е издание . Бедфорд/Сент. Мартинс.
- ^ «Технические писатели: Справочник по профессиональным перспективам:: Бюро статистики труда США». www.bls.gov . Проверено 14 февраля 2024 г.
- ↑ Джонсон, Том (19 декабря 2011 г.). «Какие инструменты используют технические писатели». Я лучше буду писать . Проверено 4 мая 2014 г.
- ^ Перельман, Лесли С.; Барретт, Эдвард; Паради Джеймс. «Виды документов». Справочник Мэйфилда по техническому и научному письму . Проверено 4 мая 2014 г.
- ^ abcdefghijk О'Хара, Фредрик М. младший «Краткая история технических коммуникаций» (PDF) . Университет штата Монтана в Биллингсе . Проверено 22 апреля 2014 г.
- ^ Аламарго, Денис; Терьер, Патрис; Селье, Жан-Мари, ред. (01.10.2007). Письменные документы на рабочем месте. дои : 10.1163/9789004253254. ISBN 9780080474878.
- ^ аб Дуди, Од; Фоллингер, Сабина; Тауб, Либа (8 февраля 2012 г.). «Структуры и стратегии древнегреческого и римского технического письма: введение» (PDF) . Исследования по истории и философии науки . 43 (2). Кембриджский университет: 233–236. Бибкод : 2012SHPSA..43..233D. дои :10.1016/j.shpsa.2011.12.021. Архивировано из оригинала (PDF) 3 августа 2012 года . Проверено 22 апреля 2014 г.
- ^ «Путь к звездам: постройте свою собственную астролябию». Колледж Святого Иоанна . Проверено 22 апреля 2014 г.
- ^ Хагге, Джон (июль 1990 г.). «Первый технический писатель на английском языке: вызов гегемонии Чосера». Журнал технического письма и коммуникации . 20 (3): 269–289. doi : 10.2190/vwcw-xkmv-949f-vlf7. ISSN 0047-2816. S2CID 170879476.
- ^ abc Крэбб, Стивен (2012). «Построение контекстуальной истории технического письма на английском языке» (PDF) . Университет Портсмута . Архивировано из оригинала (PDF) 12 мая 2014 года . Проверено 30 апреля 2014 г.
- ^ «История технического письма». Проедит . 14 сентября 2012 года . Проверено 9 мая 2014 г.
- ^ «Словарь и тезаурус». Мерриам-Вебстер . Проверено 22 января 2016 г.
- ^ Джонсон, Том «Какие инструменты используют технические писатели». Я лучше буду писать . 19 декабря 2011 г. Проверено 4 мая 2014 г.
- ^ «Что такое LyX» . Ликс . Проверено 9 мая 2014 г.
- ↑ Хьюитт, Джон (18 января 2005 г.). «Как технические писатели используют Microsoft Visio». По война . Архивировано из оригинала 12 мая 2014 года . Проверено 9 мая 2014 г.
- ^ Брайерли, Шон (2002). Снимки экрана 102 (PDF) . СТЦ Каролина (Отчет). стр. 5–8 . Проверено 9 мая 2014 г.
- ↑ Джонсон, Том (19 декабря 2011 г.). «Какие инструменты используют технические писатели». Я лучше буду писать . Проверено 4 мая 2014 г.
Внешние ссылки