Всё для технического документирования
+7 (495) 001-40-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Как инженеры могут улучшить навыки технического писательства

02.08.2013

01Хотя инженер и техническая специальность, это не значит, что любой инженер обязательно будет хорошим техническим писателем.

«Техническое писательство включает в себя два ключевых навыка, – указывает Атул Матур, профессиональный инженер и технический копирайтер в Сингапуре. – Во-первых, это способность понимать технический язык, во-вторых, способность выразить это знание в ясной, чёткой и последовательной манере».

Дэн Джонс, профессор английского языка в Университете Центральной Флориды в Орландо, который предлагает ввести курсы технических писателей для будущих инженеров, не верит, что техническое писательство «или любой вид писательства – врожденный навык». По его словам, некоторые пишут лучше других, но эти навыки приобретались большой практикой и упорным трудом в течение довольно долгого времени.

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

Модульное писательство

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

«Такая документация включает отчёты о командировках, предложения, текущие отчёты, протоколы заседаний, отчеты документирования посещений и лабораторные эксперименты, – заявляет Гэри Блейк, руководитель коммуникационной группы в Грейт-Нек, Нью-Йорк и автор «Элементов технической документации». – За 25 лет преподавания технического писательства в группе я встречал очень немного инженеров, которые с лёгкостью могут разрабатывать документацию для читателей простым языком, сохраняя короткие предложения и абзацы, и при этом изложив суть.

Один из методов борьбы с увеличенным объёмом отчётности – «модульное писательство». Многие компании отказываются от технических документов индивидуального авторства в пользу модулей информации, написанных командой.

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

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

«Недавно я работал с группой из 30 инженеров, чтобы помочь им создавать более эффективные технические презентации, –  рассказывает Джонс. – PowerPoint предназначен для простоты, в идеале это отдельные слайды, выступающие в качестве подсказки для оратора, а не в качестве раздаточного материала для аудитории. Но многие технические специалисты впихивают слишком много информации почти в каждый слайд. И во многих случаях регламенты компании или практика требуют от них предоставлять всю информацию подобным образом».

Простота в сложности

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

«Самая большая проблема заключается в неспособности увидеть простое в сложном, – говорит Матур. – Как абстрагироваться от сложности процесса или системы и представить его таким образом, чтобы другие могли понять с минимальными усилиями? В конце концов, техническое писательство – это не только знание языка, это также образ мыслей».

Здесь нет альтернативы тренингам: один-на-один, вебинары, семинары, а ещё нужно иметь возможность мгновенного контакта с экспертом или наставником. Вебинары выгодно отличается дешевизной и удобством. «Команда или отдел инженеров проходят полуторачасовое онлайн-занятие, рассматривают образцы технической документации, делают письменные упражнения, отвечают на вопросы, и получают возможность коммуникации с инструктором», рассказывает Блейк.

Технические коммуникации имеют огромное значение для всех технических специалистов для продвижения по службе.

«Освоение дисциплины, конечно, важно, но эти специальные знания становятся гораздо более ценными и востребованными, если вы знаете, как передать свои специальные знания различным аудиториям многочисленных видов технической документации и технических презентаций», подчёркивает Джонс.

Источник: How Engineers Can Improve Technical Writing

Тэги: ,

< Вернуться к списку публикаций

Облако тегов