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

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

Как глубоко убеждённый гуманитарий стал айтишником?

Я занималась в литературной студии с шести лет. Окончила магистратуру по журналистике. Работала редактором пресс-службы университета, менеджером по рекламе филармонии, главным редактором спортивного журнала. Опубликовала на Литнет научно-фантастический роман. Это типичный путь гуманитария, для которого работа над текстом — и способ заработка, и страстное увлечение.

Кто бы мог подумать что, будучи филологом со стажем, я неожиданно для себя стану сотрудником X5 Tech и буду писать технические тексты для проекта «Обратная связь» в «‎Пятёрочке».

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

Два сапога — не пара?

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

Этап 1. Всё начинается с целевой аудитории

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

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

Техпис пишет инструкции, описание сервиса, FAQ и другие виды документации, интерфейсные тексты, а также тексты для чат-ботов и рассылок. У каждого типа — свои цели и особенности. Степень детализированности описания, термины или их отсутствие диктует целевая аудитория. Поэтому прежде чем начать работу над текстом, техпис изучает Tone of Voice, а главное — определяется, кто будет читать документ и зачем. Подача материала и стиль будут совершенно разными в описании API и в текстах для чат-бота.

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

Техпис не просто перечисляет очевидные характеристики абстрактной группы людей — он: 

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

  • расспрашивает продакта;

  • задаёт вопросы бизнес- и системным аналитикам;

  • если есть возможность, старается общаться с представителями целевой аудитории.

Этап 2. Концепция творчества и концепция документа

«Всякий переводчик — немножко оборотень»

Наталия Осояну, писательница и переводчица авторов научной фантастики и фэнтези

Метафора применима к обоим писателям: читатель всегда должен быть уверен, что:

  • его любимый писатель не начнёт в детской сказке рассказывать о расследовании убийства, а в истории ужасов — о радужных пони;

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

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

Техпис размышляет:

  • что пользователь может уже знать о продукте;

  • с какими трудностями он столкнётся на разных этапах использования продукта;

  • как помочь ему не только преодолеть эти трудности, но и получить удовольствие от использования продукта.

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

Этап 3. Глобальные идея и структура

Концепция творчества у писателя служит базой, на которой взращивается и расцветает идея для книжного цикла.

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

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

Оглавление уже написанной мной книги. Третья часть цикла — «‎Тайна монаха»
Оглавление уже написанной мной книги. Третья часть цикла — «‎Тайна монаха»
Структура моей книги в разработке. Четвертая часть цикла — «‎Пламя Антрацита»
Структура моей книги в разработке. Четвертая часть цикла — «‎Пламя Антрацита»

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

На первой странице пользователь не найдёт ответы на все вопросы, но поймёт, какой путь ему предстоит пройти, чтобы в конце уверенно сказать самому себе: «Теперь я знаю, как это работает!».

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

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

  • стартовая разводящая страница;

  • новое в сервисе;

  • создание учетной записи;

  • работа с сервисом;

  • вопросы и ответы и так далее.

Содержание руководства пользователя
Содержание руководства пользователя

Этап 4. Общение как подготовительный этап

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

При этом речь не идёт о подробном плане каждой главы — только об общем понимании:

  • каким будет характер, то есть эстетика истории;

  • как книга сможет влюбить в себя читателя;

  • кто главный герой;

  • от чьего лица будет вестись повествование;

  • каким будет первое (а может быть, и последнее) предложение;

  • когда идея раскроется на все 100%.

Главное — не испугаться, если вы решили написать историю ужасов, и на ваш интерес она вдруг ответит взаимностью, как в «Гарри Поттере» дневник Тома Реддла или «Чудовищная книга о чудовищах».

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

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

Этап 5. Глубокое погружение в вымышленный мир или сервис

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

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

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

Описание вымышленного мира и героев для моего книжного цикла «Эгрегор и Тальпа»
Описание вымышленного мира и героев для моего книжного цикла «Эгрегор и Тальпа»

Техпис погружается в сервис. Для этого он проводит работу по двум разным направлениям:

  • изучает уже существующую документацию;

  • работает на тестовом стенде.

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

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

Этап 6. Структурирование собранного материала

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

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

Идеи для моей книги в разработке. Четвертая часть цикла — «‎Пламя Антрацита»
Идеи для моей книги в разработке. Четвертая часть цикла — «‎Пламя Антрацита»

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

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

Математическая точность — опция, которая активируется, как только техпис берётся за упорядочивание собранной информации. В этом во многом помогает структура документа, которую техпис разработал заранее — на этапе «Глобальные идея и структура».

Структура технического описания
Структура технического описания

Этап 7. Продумывание главы, раздела или страницы

Казалось бы, после такого количества анкет, угнетающих размышлений и стратегических игр можно уже сесть наконец-то за текст. — Увы и ах, но это не так.

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

Описание главы уже написанной мной книги. Первая часть цикла — «Игрушка беглецов»
Описание главы уже написанной мной книги. Первая часть цикла — «Игрушка беглецов»

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

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

Понимание продукта, которое прежде было верхнеуровневым, постепенно становится более глубоким и подробным.

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

Разводящая страница раздела в техническом описании
Разводящая страница раздела в техническом описании

Этап 8. Создание черновика

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

Работа над текстом похожа на лестницу к победе, но есть одно «но»: во время написания книги или документа прекрасный момент, когда черновик написан, постепенно теряет новизну и ценность. На месте ступенек к успеху появляется круг — причем замкнутый. Перед писателем стоит задача написать 20-30 глав, перед техписом — 10-15 разделов, и работа над книгой или документом перестаёт восприниматься как поступательное движение вверх. 

Писатель и техпис снова и снова делают одно и то же — создают текст, а потом уничтожает его.

Этап 9. Вычитка текста

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

Писатель редактирует и корректирует текст самостоятельно, а потом передаёт текст на вычитку профессиональным редакторам и корректорам.

Техпис сначала проводит само-, а потом и внутреннее ревью — передаёт текст на вычитку коллегам-техписам.

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

Процесс вычитки включает целый ряд задач:

  • избавиться от опечаток;

  • удалить лишние слова, предложения и абзацы;

  • заменить штампы и канцеляризмы простыми, понятными словосочетаниями;

  • проверить фактический материал и так далее.

Страница технического описания после внутреннего ревью
Страница технического описания после внутреннего ревью

Этап №10. Сохранение важных заметок

Когда мучительный процесс вычитки наконец подходит к концу, то писатели… молодцы? — Нет, пока ещё нет.

Обоим писателям приходится выпустить на волю «супергероя» —  называйте его Человеком-таблицей, Человеком-схемой или как-то ещё. 

Супергерой нужен, чтобы:

  • зафиксировать важную информацию;

  • не допустить повторов фрагментов истории или описания системы;

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

Фрагмент конспекта по главе. Первая часть цикла — «Игрушка беглецов»
Фрагмент конспекта по главе. Первая часть цикла — «Игрушка беглецов»

Когда книга или документ готовы, у каждого писателя начинается новый путь, на котором нужно:

  • утвердить книгу у выпускающего редактора или согласовать документ с заказчиком;

  • опубликовать текст;

  • продвигать книгу в соцсетях или поддерживать документ в актуальном состоянии.

Авторы текстов — супергерои?

Чтобы пройти тернистый путь, обоим писателям нужны особые навыки.

Жёсткие навыки

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

Гибкие навыки

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

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

Какие книги стоит читать, чтобы писать?

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

Вот эти книги:

  • Максим Ильяхов, Людмила Сарычева «Пиши, сокращай»

  • Нора Галь «Слово живое и мертвое»

  • Энн Ламотт «Птица за птицей»

  • Остин Клеон «Кради как художник»

  • Джулия Кэмерон «Право писать»

Какие выводы можно сделать?

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

В основе лежит не только общий принцип работы, но и похожий путь от вопроса «Кому этот текст принесёт пользу?» и до пункта «Вычитка завершена».

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

  • Под капотом или за кулисами создания текста происходят очень похожие процессы.

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

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

Хочу обрадовать всех, кто работает с текстами. Вы можете освоить для себя новую сферу — профессию технического писателя и стать частью IT-компании, вполне возможно, даже частью команды техписов X5 Tech.

Комментарии (5)


  1. A1WEB
    15.08.2024 10:10

    Техпис - звучит гордо. А вот это как будет звучать, если речь о представительнице прекрасной половины?


    1. AnnaMariaWriter Автор
      15.08.2024 10:10

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


  1. Helgich
    15.08.2024 10:10

    Звучит красиво, пока не добавишь щепотку ГОСТ...


    1. AnnaMariaWriter Автор
      15.08.2024 10:10

      А зачем нужно его добавлять? У нас разработан стайлгайд, принципами которого мы руководствуемся.


  1. S_gray
    15.08.2024 10:10

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