Профессия "Технический писатель", или "Рыцари клавиатуры"

Взаимодействие технического писателя с работодателем и руководителем на месте постоянной занятости

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

В общем случае работа технического писателя на штатной должности происходит так: непосредственный руководитель (ведущий разработчик, начальник отдела маркетинга/тех. поддержки, редактор, словом — кто угодно) ставит техпису задачу создать тот или иной документ. Писатель разрабатывает его, при необходимости консультируясь с другими сотрудниками или обходясь только имеющимся продуктом (запомните: если есть возможность справиться с задачей своими силами — не тревожьте коллег!), после чего самостоятельно делает одну-две вычитки текста и сдаёт его руководителю.

Дальше возможны два варианта:

1. В отделе или компании есть редактор, корректор или копирайтер, которые могут и должны проверить вашу работу. Им документ и попадает из рук вашего руководителя. Это самый простой и оптимальный для новичков случай — есть кому указать на ваши ошибки. При этом ваша задача — постоянно общаться с этими товарищами, чтобы они могли помочь вам, а вы, в свою очередь — выслушав и запомнив их советы, научиться писать качественнее.

2. Сотрудников, отвечающих за вычитку и проверку текстов, нет. В итоге новый документ проверяется либо непосредственным руководителем техписа (при условии, что это не редактор, а просто начальник отдела или кто-то ещё), либо только оценивается техническими специалистами на фактическую точность. Это очень плохой вариант, особенно если речь идёт о начинающем техническом писателе, так как некому проверить качество текста — все перечисленные способны оценить лишь соответствие описаний реальной программе. Увы, в такой ситуации вам придётся самостоятельно «полировать» качество своего текста. Как это делать — описано в разделе «Завершающий этап работы с текстом».

Важно отметить также, что в каком бы формате ни делался документ, в итоге он, как правило, преобразовывается в html, pdf или chm-формат: для использования на сайте, для скачивания / распечатки или для включения в программу в виде файла справки соответственно. И нужно заранее определить, кто будет отвечать за итоговое оформление документа. Как правило, при наличии проверяющих сотрудников — этим занимаются именно они, в противном случае, постараться придётся самому техпису, чтобы на выходе получить не только качественный по содержанию, но и эстетичный внешне документ в требуемом формате. Для этого, возможно, придётся дополнительно освоить продукты Adobe, html-разметку и chm-редактор.

Также нужно обговорить организационные моменты, играющие важную роль в процессе коммуникации и анализе результатов работы:

1. Как будет происходить общение в компании. Вариантов может быть несколько:

• Постоянное неформальное общение — когда вы общаетесь с руководителем и остальными коллегами «на короткой ноге». То есть свободно можете поговорить как о погоде, так и обсудить важные рабочие вопросы.

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

• Совещания — когда все вопросы, за исключением экстренных, решаются на периодических совещаниях, в остальное же время все сотрудники заняты своими задачами и отвлекать их не рекомендуется.

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

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