Техническое документирование: ежедневный рабочий процесс

01.07.2015

Канадский студент Брент Рестиво (Brent Restivo) делится наблюдениями о профессии технического писателя. Статья будет интересна тем, кто интересуется, кто такие технические писатели и из чего состоят их рабочие будни.

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

По иронии судьбы, первое определение, которое я нашёл, изобиловало жаргоном и не давало достаточно информации, чтобы получить представление об этой работе (может быть, техническим писателям стоит переписать это определение!):

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

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

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

Ежедневный рабочий процесс:

1. Сбор информации

Много-много встреч. Это новый продукт, который готовится к выпуску, и на данный момент к нему нет ни одного документа. Ваша первоочередная задача – встретиться с разработчиками кода, менеджерами продукта, главными маркетологами и внутренними бизнес-аналитиками; вашей команде нужно определить, какие документы необходимо разработать и к какому сроку. Эта задача может быть очень динамичной и приносящей внутреннее удовлетворение, и ломает ту пугающую монотонность, которую представляют при мысли о работе за столом.

2. Анализ информации

Теперь, когда вы собрали подавляющее большинство информации о новом продукте, вам пора решить, что из этого важно и в какой форме оно будет представлено. Форма может быть такой (но не только):

• Маркетинговые материалы на сайте
• Видеоролики на YouTube
• Брошюры и инструкции
• Учебные материалы

3. Проверка информации

Отлично, вы решили, на какие цели теперь работать. Теперь на вас лежит задача проверить, что вся полученная вами информация верна! Эта задача решается с помощью экспериментирования с продуктом (в нашем случае, с мобильным телефоном), а также планированием и проведением новых встреч с экспертами по продукту.

4. Создание материалов

И наконец, происходит само написание. Теперь вы создаёте документы, для которых вы проводили подготовку в течение последних нескольких недель. Эта стадия приносит наибольшее чувство удовлетворения, поскольку вы завершаете работу с тщательно подготовленными, реально осязаемыми документами, которые будут изо дня в день использоваться клиентами.

5. Перекур (но ненадолго!)

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

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

Источник: Technical Writing: A Day to Day Work Flow

Тэги: опыт, профессия