О чём пишет технический писатель?

Что за профессия

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

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

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

Какие знания и навыки нужны

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

Я по образованию журналист. И считаю, что диплом сыграл в мою пользу, потому что:
— умею работать с текстами;— знаю, как брать интервью и превращать его в интересный рассказ;
— умею добывать и обрабатывать информацию.
Марина Вашак, технический писатель

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

— технический склад ума и системное мышление — отличные спутники в IT-сфере;

— навыки программирования помогут понимать разработчиков;

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

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

Есть и базовый набор умений, которые не зависят от образования, но сильно упростят техпису жизнь:

• Грамотность. Теоретически неграмотный технический писатель может существовать, но ему будет нелегко. Конечно, при вычитке все ошибки найдутся и исправятся, но важно самостоятельно уметь превращать свои мысли в грамотные предложения.

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

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

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

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

• Адекватная обратная связь. В дополнение к предыдущему пункту: технический писатель — это не только писатель, но и читатель. У разработчиков есть код-ревью. У технических писателей, если их больше одного, в идеальном мире есть ревью текстов. Потому что, опять же, все ошибаются, глаз замыливается, а две головы всегда лучше одной. И если нужно вычитать текст и дать обратную связь, понадобится много эмпатии и заинтересованности в общем результате, а не высокомерное «всё фигня, переделывай».

Как понять, что работа мне подходит

Возьмите приложение любимого банка и напишите инструкцию к какому-то простому процессу. Например, как оплатить мобильную связь. Покажите эту инструкцию друзьям или родителям, попросите проверить и попробовать пополнить баланс, следуя ей. Если инструкция сработала — поздравляю, это прекрасный старт, вы готовы к тестовым заданиям.

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

Однажды мне дали задание: написать инструкцию к кошке. Пожалуй, это было самое милое тестовое. Я описывала кошку как самораспаковывающуюся систему. Подготовить платформу для установки и выбрать источник нужно заранее.
Благодаря таким бытовым инструкциям можно оценить, как мыслит и пишет кандидат. А тестовые по реальным кейсам дадут представление о его умении разбираться в непонятных терминах и находить информацию.
Марина Вашак, технический писатель

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

Ещё есть чаты увлечённых техписательством людей. Можно проникнуть туда, чтобы посоветоваться, попросить вычитать текст или дать ОС. Там и вакансии периодически публикуют.

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

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

Как научиться писать понятные инструкции

• Много писать — дневники, посты в соцсетях, каналы в «Телеграме».

• Читать — любую литературу: научпоп, художественную, научную.

• Развивать насмотренность. Изучайте инструкции к продуктам, которыми пользуетесь: банковским приложениям, сервисам доставки, такси, мессенджерам. Как они написаны, в каком формате, где лежат. Оценивайте, понятно ли вам. Если нет — пробуйте переписать, чтобы стало понятно.

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

Полезные ресурсы про тексты и интерфейс

• Технические писатели. Большой чат, где можно попросить совета, найти единомышленников, полезные материалы и даже работу.

• Копилка текстов. Примеры текстов разной степени годноты.

• Техпишу и копирайчу. О техническом писательстве, текстах и развитии карьеры. Пишет техпис, прошедший за год путь от стажёра до мидла.

• Техписалити! — первая открытая школа технических писателей.

• Техпис говорит — подкасты о разработке документации.

• Просто добавь в бэклог — про технические коммуникации и best practices в документировании и UX.

А ещё — полезные книги:

• А. Мильчин, Л. Чельцова «Справочник издателя и автора».

• М. Ильяхов «Пиши, сокращай».

• М. Ильяхов «Ясно, понятно: как доносить мысли и убеждать людей с помощью слов».

• М. Ильяхов, Л. Сарычева «Новые правила деловой переписки».

• Е. Рыжкова «Текст за текстом. Как создавать контент системно, быстро и легко».

• Д. Роэм «Бла-бла-бла, или Что делать, когда слова не работают».

• Л. ЛеФевер «Искусство объяснять».

• А. Симмонс «Сторителлинг. Как использовать силу историй».

• П. Черри «Продающие вопросы. Эффективный способ выяснить, чего действительно хотят ваши клиенты».

• К. Егерев «Этой кнопке нужен текст».