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

Что делать со старыми инструкциями? (часть 2)

13.12.2013

01Представляем вам продолжение письма Тома Джонсона, опубликованного в его блоге. Первая часть тут.


Чтение всех этих руководств неизменно начинается с поздравлений с покупкой продукта. Я уже писал об этих клише в статье Five Ways to Avoid the “Congratulations Clich?. Но теперь я вижу в таких приветствиях реальную цель. Всё, что хочет сказать технический писатель, – это «спасибо, что приобрели этот продукт, без вашей поддержки я остался бы без работы». Это код, который понятен только братству техписов. Как видите, у меня есть доступ к подобным тайнам. «Спасибо, спасибо, что наняли меня» – говорят они.

Я бы хотел, чтобы люди, которые создают инструкции по сборке устройств, добавляли в свои руководства немного юмора, чтобы немножко улучшить моё плохое отношение к сборке чего-либо вообще. Однажды я собирал пару двухъярусных кроватей из IKEA, а к ним шёл такой огромный пакет с гайками, что, клянусь, их туда насыпали лопатами.

Ненавязчивая шутка в начале руководства может неплохо помочь. Как насчёт «Пожалуйста, возьмите и взвесьте в руке здоровенный мешок гаек. Вашей первой мыслью будет: «Боже, сколько гаек!». Мы знаем, знаем, успокойтесь. Через пару часов всё закончится. Ну, если, конечно, вы отлично умеете работать руками. Шучу, наша инструкция вам поможет. Но на самом деле, не теряйте гайки. Вам понадобится все до единой 🙂 ».

Сейчас мне легко шутить, потому что я не пытаюсь что-нибудь собрать  и подключить. Поэтому, думаю, юмор будет более уместен в конце инструкции, когда работа уже сделана. Но всё же, будьте более позитивны. Вот почему во время войны были так популярны комиксы. В паршивой ситуации (на сборах или на войне) вам нужно что-то, чтобы отвлечься. Вам нужен кто-то, не такой серьёзный и напряжённый, как вы.

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

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

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

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

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

Источник: What to do with old manuals from products you own

Тэги: , , ,

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

Облако тегов