Кто такие технические писатели и зачем они нужны IT-компании

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

 

Как строится работа технического писателя? Что ему нужно знать и уметь? Какими бывают технические тексты? Что сложнее всего в их написании? Об этом мы поговорили с Ольгой Шабановой, которая пишет технические тексты в EPAM.

 


 

Что это за специалисты и зачем они нужны

 

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

 

  • инженеры, которые поддерживают программы или дорабатывают их;
  • пользователи разного уровня подготовки, для которых эти программы и создаются.

 

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

 

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

 

Ольга Шабанова: «Технические писатели делают документацию либо на уже готовый продукт, либо на определенное решение внутри него. Проекты разные, и набор того, что и для кого задокументировать, не всегда одинаковый. Одному проекту достаточно подробной инструкции для технических специалистов, другим потребуется пакет документов и для поддержки, и для обычных пользователей».

 

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

 

Ольга Шабанова: «Как и в работе с любым текстом, главное – ориентироваться на конечного пользователя: какие проблемы с помощью документации он будет решать, какой у него уровень подготовки, насколько подробно всё должно быть описано. Сейчас я работаю над документацией для внутренней системы EPAM по информационной безопасности. Пользоваться ей будут технические специалисты. Требование к такой документации — чтобы она была подробной, пусть и длинной, чтобы в ней было много скриншотов и примеров, которые показывают, как решить ту или иную проблему. Когда системный администратор изучит такую инструкцию, у него не должно остаться вопросов, как пользоваться программой. На другом проекте я пишу небольшие части документации, связанные с конкретной функциональностью и изменениями в ее работе. Здесь тексты не такие большие и подробные. И там, и там главная задача – чтобы человек быстро нашел в инструкции то, что ищет, и поиск не отнял у него слишком много сил».

 

 

Что нужно знать и уметь техническому писателю?

 

 

В зависимости от проекта, компании, сферы работы к техническому писателю предъявляют разные требования. Среди основных: знать язык, уметь писать на нем тексты и редактировать их.

 

 

 

 

На некоторых проектах техническим писателям требуется знание специфических программ: AutoCAD, Visio, Corel Draw, Confluence, Jira, UML, SysML, IDEF. Часто работа идет в стандартных текстовых редакторах и программах для работы с изображениями.

 

Ольга Шабанова: «В моей работе важно хорошо знать иностранный язык. Я умею писать на трех: немецком, испанском и английском, но в EPAM мне требуется только английский. На собеседовании проверяют, как ты переводишь с английского на русский и наоборот. В этой профессии важна любовь к деталям – замечать мелочи, быть внимательным к пользователю: если, например, в одном пункте изменилась ссылка, нужно найти все места, где еще она была указана, и исправить везде. Еще одно важное умение — поставить себя на место конечного пользователя и задать те вопросы, ответы на которые он будет искать в документации».

 

В некоторых IT-компаниях требуется, чтобы технический писатель знал языки разметки текста или один из языков программирования на уровне чтения кода, другим важны навыки работы с базами данных или в системах управления запросами. То, что пригодится точно – интерес к той сфере, о которой пишешь:

 

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

 

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

 

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

 

Ольга Шабанова: «Я получаю заявку на документацию и сначала пытаюсь самостоятельно разобраться, как работает то, что описываю. Вопросы, которые возникают практически неизбежно, я собираю и задаю специалисту, который знает всё о продукте. Обычно это разработчик или менеджер проекта. Иногда бывают типовые документы и простые обновления документации. В этом случае я вначале самостоятельно составляю документацию или вношу правки в имеющуюся, а потом отправляю её на проверку. Затем получаю обратную связь и вношу правки».

 

Вот как строится процесс работы:

 

  1. Определить главные задачи документации, ее адресата.
  2. Составить план технической документации.
  3. Понять, как работает программа или устройство.
  4. Уточнить то, что неясно, у инженеров.
  5. Продумать и подготовить иллюстрации к тексту.
  6. Написать текст и отправить его на проверку.
  7. Внести правки от разработчиков и согласовать документацию.
  8. Передать документацию команде разработки.

 

Ольга Шабанова: «Частая проблема, с которой я сталкиваюсь в работе – получить нужную информацию. У инженеров много других задач, и ответить мне – не приоритетная. Если не отвечают, а сроки горят, приходится напоминать разработчику о себе, а если это не срабатывает – обращаться к менеджеру и просить ускорить процесс. Ещё одна проблема – разработчик всё объяснил подробно и хорошо, но ряд терминов тебе как человеку с гуманитарной подготовкой просто непонятен. В этом случае нужно задать уточняющие вопросы сразу, по горячим следам, или поискать в интернете точные значения терминов».

 

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

 

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

 

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

 

Ольга Шабанова: «Я закончила бакалавриат по международным отношениям, где выучила иностранные языки, и магистратуру по журналистике, где прокачала навык написания текстов. Поработала журналистом, поняла, что это не мое, затем занималась связями с общественностью, тоже не подошло. Затем была переводчиком, постепенно пришла к техническим текстам – переводила на испанский инструкции на вооружение. Помимо документации на танки и самолеты, там попадались тексты и по управлению информационными системами. Затем я переводила на немецкий документы для IT-компании, а потом нашла вакансию технического писателя со знанием английского».

 

Тем, кто хочет стать техническим писателем, рекомендуем обратить внимание на эти ресурсы:

 

 

Какую карьеру может построить технический писатель?

 

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

 

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

 

Источники фото: unsplash.com