Спроси меня, как я, хм, пишу технические тексты

22.07.2013

Мы публикуем очередную полушуточную-полусерьёзную заметку Ларри Кунца, в которой он сравнивает работу технического писателя и работу над фигурой. Надеемся, эта публикация скрасит ваш понедельник.

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

О чём вы не можете говорить в Twitter? Когда вы видите твит, в котором написано: «Спроси меня, как я скинул вес», разве вы тут же не подумаете, что Twitter-аккаунт отправителя был взломан? Это приводит к неизбежному выводу: если я когда-нибудь скину значительный вес, никто в Twitter этому не поверит.

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

Спроси меня, как я пишу технические тексты. Ну, знаете: как я работаю техническим писателем.

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

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

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

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

Техническое писательство имеет со всем этим много общего. С помощью правок и отзывов мои коллеги помогают мне оттачивать мастерство.  Я взвываю к ним, когда мне нужна помощь – будь это что-то маленькое, как поиск нужного слова, или что-то большое, как освоение нового рабочего процесса.

Мы все знаем, что большинство технических писателей работают как «писатели-одиночки». Если вы работаете в одиночку, очень важно объединиться с другими специалистами либо путем создания виртуальной сети, либо (в идеале) через такие ассоциации, как STC (Сообщество Технических Коммуникаций).

А как насчёт вас? Чему вы научились в повседневной жизни, что вы нашли полезного в работе технического писателя?

Источник: Ask me how I, um, tech write

Тэги: Ларри Кунц, опыт, юмор