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

FAQ по профессии «Технический писатель»

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

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

Кто такой технический писатель?

На этот вопрос ответили три ведущих специалиста компании ПроТекст. Вот что получилось:

1) Технический писатель – профессия востребованная и интересная, но пока редкая. Технические писатели – специалисты, которые технически сложные вещи 06могут объяснить простым человеческим всем понятным языком. Они умеют писать и одновременно разбираются в технике и технологиях.

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

3) На мой взгляд, технический писатель, это, прежде всего, переводчик с русского на русский. Он разговаривает с разработчиками и технарями на одном языке, подчас непонятном рядовым пользователям, а потом пишет материалы на другом языке, простом и понятном любому человеку. Хороший разработчик, за редким исключением, не сможет просто и доступно рассказать о своём детище – для него оно всё «элементарное и понятное», тогда как технический писатель, находясь между создателем и пользователем, в состоянии рассказать о любой сложной вещи простым языком. Обратное тоже верно – когда заказчик, знающий свою область, но не знающий программирования, пытается напрямую объяснить разработчику свои задачи – результат непредсказуем. Надо звать кого-то из наших коллег, чтобы он пояснил сторонам, что же им всё-таки нужно.

Какое образование должен иметь технический писатель – техническое или гуманитарное?

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

Есть ли вузы, которые учат именно на технических писателей?

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

Какова глобальная роль технического писателя?  03

По сути, технический писатель – это переводчик «с русского на русский», в совершенстве владеющий как «языком пользователя», так и «языком разработчика». Есть два варианта:

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

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

В каких областях может работать технический писатель?

Области работы технического писателя перечислить трудно – это вся IT-отрасль, кроме того, наука, журналистика (да-да, хороший, схватывающий на лету технический писатель после нескольких лет практики сможет описать что угодно), любая сфера, связанная с применением электронного оборудования, энергетикой. Зачастую ставятся задачи аналитического характера, а значит, частенько приходится залезать в экономику и бизнес-планирование. Что интересно, многие аналитики выросли именно из технических писателей, после длительной работы в качестве фрилансеров, журналистов или штатных техписов – писали обзоры, выполняли анализ рынков и прочее. Короче, умелец тот ещё, чем и ценен.

Какие задачи приходится выполнять техническому писателю? 

Здесь мы не будем упоминать атавизмы типа «принести чай» и «настроить принтер», а рассмотрим типовые задачи, с которыми работают техписы.02

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

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

— Создание технических заданий – здесь есть два основных подвида: создание ТЗ по ГОСТ, как части общей документации на разработку (чаще всего при гос. контрактах). Второй вид – создание ТЗ на разработку для самих разработчиков. Оно может быть гораздо менее формальным и более подробным.   

— Создание презентационных материалов – сюда можно отнести написание пресс-релизов, создание презентаций, текстов различных брошюр, рекламных буклетов и т.д.

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

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

— Корректура и редактура – вычитка существующих текстов, их исправление и, при необходимости, дополнение и актуализация.

Написание руководств и инструкций – основная часть работы. А какие руководства бывают?

05— Руководство пользователя – руководство для рядовых пользователей. Описывается всё просто и понятно. Главное – функциональность, описания настроек может не быть.

— Руководство администратора – документ для тех, кто ковыряется на уровне администратора в крупных комплексах. Пишется только для крупных систем, требующих специалиста, который будет контролировать их. 

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

В каком режиме может работать технический писатель?

В отличие от специалистов многих других профессий, техпис может работать не только как офисный сотрудник, но и как удалённый работник, при этом не теряя04 свою функциональность. Здесь важно понять, когда реально необходимо работа в офисе (например, если работы всегда много и идёт непрерывное консультирование с сидящими в соседнем кабинете программистами), а когда это просто формальность и работать можно дома. Перечислять плюсы работы дома можно долго, а минусов существует всего два: может сузиться круг общения и, порой, трудно заставить себя работать. Дом – наша зона комфорта и ассоциируется прежде всего с отдыхом и расслаблением, а потом уже с работой. Плюс, при таком ритме вы «всегда на работе». Выбрать работу в офисе или удалёнку – решение каждого, но учитывать надо все указанные выше факторы. Можно одичать, можно залениться и провалить работу, можно взвалить на себя слишком много и сидеть не отрываясь. Нужен баланс.