Технический писатель в продуктовой компании

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

Круг задач технического писателя

Технический писатель включается в работу над продуктом с момента его создания и сопровождает его на всех этапах:

● Когда продукт создается – готовит техническую и эксплуатационную документацию;

● Поддерживает актуальность документов в связи с выходом новых версий;

● Если продукт дорабатывается под заказчика – ведет проектную документацию;

● Если продукт является средством информационной безопасности, готовит документы согласно требованиям ФСТЭК России для сертификации.

Технический писатель может работать по следующим направлениям:

● Разработка различных видов документации (справки, руководства, презентации, базы знаний).

● Корректировка (устранение грамматических и пунктуационных ошибок);

● Редактура (стилистическая и смысловая обработка текста);

● Аналитика (исследования в заданной области);

● Публицистика (написание статей).

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

Важный момент: технический писатель ни в коем случае не должен брать на себя подготовку кадровых и юридических документов. Такая документация находится в ведении других специалистов.

Компетенции технического писателя

Эта профессия находится на стыке гуманитарных и технических наук. А значит, с одной стороны, техническому писателю надо уметь хорошо писать, обладать «языковым чутьем». С другой стороны, у него должны быть «мозги математика», чтобы разбираться в технической стороне ИТ-продукта.

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

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

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

Как строится общение технического писателя с коллегами

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

● Главное – уважение к коллегам и их времени. Сначала надо самому изучить тему максимально глубоко и лишь после идти за консультацией, если это необходимо.

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

● Если с вами не хотят общаться, нужно терпеливо объяснить, чем важна задача, с которой вы обратились.

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

● Если вопрос объемный, разбейте его на несколько.

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

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

Как создаются технические инструкции

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

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

Требования к документу можно разделить на три группы:

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

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

● Требование к соответствию касается критериев актуальности, полноты и детальности. Актуальный и полный документ содержит только ту информацию, которая необходима читателю и в полном объеме. Предоставляемая информация должна быть точной и соответствовать описываемой версии продукта. Иногда пользователю для полноты представления о продукте нужны данные, которые неуместны в рамках документа. В таком случае задача технического писателя переадресовать его туда, где пользователь найдёт нужные сведения. Детальный документ должен содержать достаточные конкретные сведения, необходимые для того, чтобы документ выполнял свою функцию.

Как создать стильный текст

● Чем короче текст, тем лучше.

● Избавляемся от канцеляризмов.

● Помним, что мы пишем не для себя, а для читателя.

● Понимаем сами, о чем и зачем пишем.

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

● Впечатление связности текста создается, когда последние слова одного предложения подготавливают читателя к первым словам следующего.

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

● Не боимся использовать автоматические редакторы для повышения качества текста. Например, MS Word проверяет коэффициент удобочитаемости, ChatGPT рекомендует варианты переформулировки предложения.

Где учиться на технического писателя

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

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

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

Карьерные возможности технического писателя

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

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

По мнению автора книги «Профессия «Технический писатель» Александра Михайлова, вершина горизонтального роста технического писателя – это технический коммуникатор. Этот человек может всё: написать комментарий к коду, технический или эксплуатационный документ, рекламный текст, создать видеоролик или презентацию.

На данный момент нет единого подхода к оценке KPI работы технических писателей. Некоторые компании оценивают количество страниц, знаков или потраченных часов, но такой подход не учитывает качество документа. Профессиональную оценку может дать только опытный специалист, но она будет субъективна. Практическую оценку документу дает пользователь. Отсутствие дополнительных запросов со стороны пользователей – показатель качества разработанного документа.

Технический писатель – это перспективно

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

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

Нет ли угрозы профессиональному будущему выпускников со стороны искусственного интеллекта? Я считаю, что, несмотря на его бурное развитие, он не угрожает профессии технического писателя по двум причинам. Первое, ИИ не придумывает новое, а обрабатывает существующее, в то время как люди постоянно находятся в исследовательском поиске. Второе, существует человеческий фактор при постановке задач и межличностном взаимодействии.

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