Один день из жизни технического писателя

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

«Утро понедельника началось с продолжительного звонка будильника. Открываю глаза, на часах 6.40. Вот и наступила рабочая неделя. Одеваюсь, выпиваю кружку горячего кофе. Спасибо этому волшебному напитку, что избавляет нас от полудремы, выветривая остатки приятного сна.

Иду на работу. Захожу в офис. Приветливо здороваюсь с секретарем на ресепшене и также встречаю своих коллег. Включаю компьютер, запускаю все необходимые программы. С этого момента вся жизнь будто закипает…

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

Ровно в 9.00 начинается stand-up митинг, в компании мы его называем по-свойски «Летучка».

Вы спросите, что это такое? Летучка – это короткое собрание всех писателей с целью осветить текущую деятельность каждого (что сделали в прошлый день, что делаем сегодня, что планируем сделать на неделе). Зачем это нужно? Над отдельным проектом обычно работает не один человек, а несколько. Поэтому нужно, чтобы каждый был в курсе дел и смог вовремя получить необходимую информацию.

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

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

Теперь я создаю документ, в котором буду разрабатывать описание программы.

Перед началом описания необходимо изучить функционал. То, как вы поймете его изначально, повлияет на качество текста в целом.

Чтобы посмотреть, как работает программа, запрашиваю ее в отделе разработки. Для начала в документе создаем примерную структуру – в какой книге будет располагаться новый текст, какие разделы появятся, что они будут в себя включать.

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

Вам сложно понять, что нужно писать, с чего начинать, как писать? Не переживайте.

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

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

Если возникают вопросы, ответы на которые не удалось найти ни в технических проектах, ни в интернете, можно напрямую обратиться с вопросами к разработчику. Бояться тут нечего. Каждый сотрудник компании дружелюбно ответит вам либо перенаправит к человеку, который более компетентен в поставленном вопросе. Не забывайте, мы же одна команда!

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

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

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

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

Во второй половине дня мне пришла задачка по сборке руководства пользователя в формат PDF. Сложно? Совсем нет. Открываю руководство в программе Help&Manual, умеющей собирать тексты в нужный мне формат, выполняю несколько настроек по инструкции и нажимаю на кнопку «Опубликовать».

Готово! Все элементарно и просто. Доработали оформление, а там уже и вечер подступил.

На этом мой рабочий день закончился. А завтра мне предстоит снимать видеоролики! Да-да, справка может быть не только текстовой и статичной, но и интерактивной.

P.S. Надеюсь, теперь вы отчасти представляете себе, кто такой технический писатель. А вы бы хотели им быть? Решайтесь и пробуйте!