Статья размещена на сайте Мили Котляровой — фрилансера с 10-летним стажем, монтажера, контент-маркетолога и сценаристки. Если хотите каждый день читать о фрилансе, работе с заказчиками и освоении новой профессии, подписывайтесь на канал Digital Broccoli в Телеграме.

Упоминающиеся в тексте Instagram и Facebook признаны на территории РФ экстремистскими.

Текст Нины Ереминой

Всё больше компаний ищут специалистов на позицию технического писателя: на момент публикации на Хабре 167 вакансий по запросу «технический писатель», а на Upwork — 708. И, по версии Бюро статистики труда США, заинтересованность в профессии будет только расти, потому что на рынке постоянно появляются новые продукты. В среднем технический писатель зарабатывает 91 тысячу рублей.

Технический писатель — это необязательно full-time должность, вы можете совмещать эту работу с другими задачами. Например, быть разработчиком, переводчиком, аналитиком или дизайнером и выполнять роль технического писателя. 

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

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

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

Создание документации

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

Виды документации: 

  • Пользовательская документация

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

  • Administrator Guide

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

  • Developer Guide

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

  • Whitepapers 

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

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

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

Техническая коммуникация

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

Например, если в пользовательской документации вы называете админку Admin dashboard, то она не должна внезапно стать Admin panel в одной из статей. Чтобы сохранить единство терминологии и стандартов, технический писатель разрабатывает внутреннюю базу знаний, где всё это прописано, и может обучать новых сотрудников компании.

Смежные области

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

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

  • UX-писателем — он помогает улучшить тексты в интерфейсе продукта или приложения;
  • инженером по документированию (DocOps) — он поддерживает процессы автоматизации документации и переводов;
  • инженером по локализации — он занимается техническим переводом;
  • техническим евангелистом (специалистом по Developer Relations) — он скорее технический маркетолог, и продвигает технические решения среди коллег или на рынке. Главное отличие евангелиста от маркетолога — знание всех технических аспектов продукта, и чаще всего технический бэкграунд.

Что нужно знать? Инструменты технического писателя

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

  • Язык

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

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

  • Копирайтерские навыки

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

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

  • Технические знания

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

  • Профессиональные текстовые редакторы

Инструменты, которыми пользуется технический писатель, зависят от задач и степени сложности. Начинать писать документацию можно и в Google Docs, но с увеличением количества связей и уровней будет сложно её поддерживать. Тогда на помощь приходят профессиональные редакторы для технических писателей: MadCap Flare или Confluence. 

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

  • Руководства по стилю

Руководства по стилю — это сборники правил, они помогают соблюсти требования к оформлению, принятые в определённой среде или типе документов. В них можно проверить правила пунктуации, выбора слов и форматирования. Например, Chicago Manual of Style чаще всего используют для написания работ, связанных с историей и общественными науками.

Примеры руководств:

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

Александр Петрович, руководитель отдела технической документации из Macroscop, советует досконально изучать интересующую область: 

«Я считаю, что стартовать надо в той области знаний, в которой вы компетентны. Либо прокачать свои знания в той сфере, с которой вы планируете начать свой путь техписателя. Для работы в IT, например, я настоятельно рекомендую освоить как минимум HTML и CSS, а оптимально — ещё и основы JavaScript и распространённых веб-фреймворков.

Без владения современными инструментами подготовки визуального контента тоже не обойтись. Я имею в виду редакторы векторной и растровой графики, средства подготовки веб-анимации и другие подобные инструменты. А с учётом того, что мир стремительно “скатывается” из текста к видео, не исключено, что скоро от техрайтеров потребуются навыки видеосъёмки, монтажа, а возможно и актёрское мастерство».

Как сделать портфолио?

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

  • Включайте только документы, которые имеют отношение к техническому письму. 
  • На ClickHelp рекомендуют найти что-то близкое из того, что вы уже писали. Главное, чтобы это был формальный текст с чёткой структурой, например, отчёт. 
  • На Reddit делятся информацией о заданиях для техрайтеров, из которых можно собрать портфолио, даже если реальных задач ещё не было. Встречаются любопытные задания, например, переписать инструкцию по сборке мебели из IKEA словами.
  • Возьмите инструкцию к сервису и попробуйте её улучшить.
  • Примите участие в ежегодном Season of Docs от Google, где технические писатели создают документацию для реальных проектов.
  • Поищите опенсорсные проекты на GitHub и предложите им написать документацию для пользователей. Это поможет вам поработать над реальной задачей, получить отзывы, и повысит шансы на отбор в Season of Docs.

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

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

Я получила много отказов. Думаю, это произошло потому, что я откликалась на все вакансии подряд, почти без разбора, и часто не могла адекватно оценить, подхожу ли я на вакансию, на которую пытаюсь устроиться. Но как говорится, если долго мучиться, то что-нибудь получится. Вот и у меня получилось: спустя N попыток меня пригласили на первое в жизни собеседование, затем предложили тестовое задание, а через несколько дней сделали предложение о работе. Я, конечно, согласилась».

Где учиться?

Курсы

  • Бесплатный курс на Stepik начинается с теста на уровень английского, который состоит из четырех частей. Он проверяет грамматику и словарь и опирается в оценке на Кэмбриджскую систему оценки знаний. В нем освещаются темы грамматики, выбора слов, которые соответствуют стилю, и пунктуации. В конце курса вы сможете пройти тест. Курс не расскажет, как работать техрайтером, но поможет снять стресс насчет языка.
  • Курс по API документации на Udemy преподаёт Питер Грюнбаум (Peter Gruenbaum), разработчик, который стал техническим писателем и специализируется на API документации. Стоимость курса $24.99, но на Udemy часто бывают скидки.
  • Курс Technical Writing: Documentation on Software Projects создан для разработчиков, но его можно проходить тем, кто собирается заниматься только письмом. Автор курса детально разбирает процесс создания технических документов, даёт советы, как писать и оформлять документацию для разработчиков, тестировщиков и конечного пользователя. Платформа платная, но деньги списываются через 2 недели, за которые можно пройти курс.
  • TCTrain Professional Course полноценный курс от организации TeKom на 8 месяцев. С сертификатом и нагрузкой на 7 часов в день. Цена на сайте не указана. 
  • Бесплатный курс от Google, который предназначен для разработчиков, но вполне подойдёт для того, чтобы познакомиться с тем, как писать понятную техническую документацию, как её правильно форматировать и использовать язык разметки.
  • Курсы для тех, кому сначала хочется освоиться с технической частью. Легендарный курс CS50 по основам программирования поможет понимать, о чём говорят коллеги, и увереннее чувствовать себя в технических темах. На Coursera есть курс Google IT support, который поможет разобраться, как устроена техподдержка.

Каналы и блоги

  • Ютуб-канал documentat.io расскажет про основные инструменты и стандарты. На нем собраны видео с бесплатного курса, который периодически повторяется.
  • Интервью Как стать техническим писателем.
  • Тред /technicalwriting на Reddit помимо вопросов об инструментах или карьерном выборе содержит возможности для волонтёрства.
  • Телеграм-канал Technical Writing 101 публикует много полезностей, а ещё заходят HR с вакансиями, где можно посмотреть, какие тестовые задания просят сделать, и выполнить самому.
  • Телеграм-канал Techwriter’s Daily собирает статьи, анонсы мероприятий, курсов и вебинаров.
  • Телеграм-канал Shut up and write с советами, новостями, удачными примерами технической коммуникации, исследованиями. Например, вот подборка сайтов, где можно найти себе ментора.
  • Телеграм-канал DocOps с информацией про инструменты, техники и мероприятия. У канала также есть чат, где можно спросить совета и пообщаться с другими техрайтерами.
  • YouTube-канал технической писательницы Amruta Ranade, с отдельным плейлистом для начинающих техрайтеров.
  • Блог I’d rather be writing, в котором Том Джонсон, техрайтер из Сиэтла, пишет про API-документацию, техническую коммуникацию и тренды.
  • Блог ClickHelp про техническое письмо. Здесь вы найдёте советы, объявления о конференциях и авторские колонки.
  • Канал Write the Docs в Slack, где можно спросить совета, познакомиться с другими техрайтерами, узнать про отраслевые мероприятия или найти первую работу, там добавляют и вакансии.
  • На DocToolHub собрано 600+ статей на темы от построения карьеры до написания API документации.
  • Подкаст Cherryleaf часть блога про техническую коммуникацию, есть выпуски с отзывами на курсы и описанием трендов.

Книги

  • Technical Writing 101 написана простым языком и отвечает на вопросы про технические ресурсы, проблемы при создании документации и особенности планирования документации на проекте. Ещё в ней есть детальные описания процесса документации, от планирования и ресёрча до публикации. 
  • Handbook of Technical Writing была написана еще в 2003, и это её десятое переиздание. Конечно, IT-индустрия меняется гораздо быстрее, но в книге есть всё еще актуальные примеры документации, принципы организации и форматирования документов, и много информации о техническом языке.
  • Пиши, сокращай поможет с пользой для читателя и заботливыми формулировками.
  • Tech Writing Handbook — коротенькая книжка с совсем основами, но очень дружелюбная, и ответит на основные вопросы в самом начале пути технического писателя.
  • Technical Writing Course Manual — неплохое собрание теории, разве что часть про MSWord устарела.

Что можно сделать прямо сейчас?

  1. Прочитайте книгу «Пиши, сокращай» — что бы вы ни собирались сокращать, в технической документации ценится лаконичность.
  2. Пройдите любой бесплатный курс и посмотрите, кажутся ли интересными задачи.
  3. Напишите инструкцию к пользованию любимым сервисом для новичков. Разберитесь что к чему, соберите скриншоты и протестируйте на знакомом, который им не пользовался. Если по вашей инструкции всё вышло и вам понравилось — продолжайте писать.
  4. Добавьтесь в один из Телеграм-каналов из предыдущей секции, найдите вакансию для джуниоров и попробуйте выполнить техническое задание.
You May Also Like
Как стать графическим дизайнером
Читать статью

Хочу стать графическим дизайнером с нуля: с чего начать?

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

Путь в профессию: как с нуля стать дизайнером интерьеров

Давно мечтали создавать дизайн интерьеров? Почитайте, как осуществить эту мечту, где этому учиться и какие качества нужны дизайнеру интерьеров.
Читать статью
Читать статью

Как стать тестировщиком ПО с нуля: чему и где учиться и где искать первую работу

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

Как стать фронтенд-разработчиком без знания кода и найти заказы за рубежом

Попасть в веб-разработку без знания кода, зарабатывать 300-400 долларов за проект на зарубежных биржах и путешествовать реально, если очень захотеть.
Читать статью
Как стать fullstack-разработчиком на Python
Читать статью

Fullstack-разработчик: кто это, чем занимается и как создавать собственные приложения на Python

Почему стоит обратить внимание на Python, что и где изучить в первую очередь и сколько могут зарабатывать фулстек-разработчики.
Читать статью