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

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

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

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

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

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

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

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

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

Например, если в пользовательской документации вы называете админку 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 устарела.
Что можно сделать прямо сейчас?
  • Прочитайте книгу «Пиши, сокращай» — что бы вы ни собирались сокращать, в технической документации ценится лаконичность.
  • Пройдите любой бесплатный курс и посмотрите, кажутся ли интересными задачи.
  • Напишите инструкцию к пользованию любимым сервисом для новичков. Разберитесь что к чему, соберите скриншоты и протестируйте на знакомом, который им не пользовался. Если по вашей инструкции всё вышло и вам понравилось — продолжайте писать.
  • Добавьтесь в один из Телеграм-каналов из предыдущей секции, найдите вакансию для джуниоров и попробуйте выполнить техническое задание.
Другие статьи из раздела СМИ о нас
07 Октября
СМИ о нас  
Почему обучение технического писателя — это нетривиальная задача
01 Октября
СМИ о нас  
IT-компания Lad помогает бизнесу и государству управлять HR-капиталом
28 Сентября
СМИ о нас  
ООО «Платформа строительных сервисов» — серебряный партнер конференции #ГИСОГД2021
27 Сентября
СМИ о нас  
Проект управления HR капиталом региона представлен на «ПРОФ-IT»
27 Сентября
СМИ о нас  
Список региональных IT-проектов – победителей конкурса «ПРОФ-IT.2021»
27 Сентября
СМИ о нас  
IX Всероссийский форум «ПРОФ-IT» — фотолента
СМИ о нас  
ТВ: На старт благотворительного забега “Открытые сердца” вышли более 200 человек
30 Августа
СМИ о нас  
Топ-17 крупнейших ИT-компаний Нижнего Новгорода
18 Августа
СМИ о нас  
Нижегородская область лидирует по доступности мер поддержки IT-компаний
05 Августа
СМИ о нас  
Прокачиваем анимацию с react-native-reanimated. Часть 1
02 Августа
СМИ о нас  
Чем занимается технический писатель: опыт IT-компании Lad
30 Июля
СМИ о нас  
Пишем свой dependency free WebSocket сервер на Node.js
27 Июля
СМИ о нас  
Сколько стоит рекомендация IT-специалиста в Нижнем. Аналитика
16 Июля
СМИ о нас  
IT-компания Lad вошла в ТОП-5 работодателей по найму Junior-разработчиков
28 Июня
СМИ о нас  
10 эко-приложений, которые помогают спасать природу
27 Июня
СМИ о нас  
IT-кампус на 7 000 студентов создадут в Нижнем Новгороде
23 Июня
СМИ о нас  
В Нижнем Новгороде пройдет паблик-ток о развитии IT-сферы
23 Июня
СМИ о нас  
В Арсенале обсудят IT в Нижегородской области
16 Июня
СМИ о нас  
Обучающая программа «Веб-разработка» от HiBrain стартовала при ННГУ
15 Июня
СМИ о нас  
Оплатить ЖКХ в режиме онлайн теперь можно на портале «Карты жителя Нижегородской области»
10 Июня
СМИ о нас  
«Прекрасная идея» или напрасные затраты? IT-бизнес — о проекте редевелопмента Започаинья
10 Июня
СМИ о нас  
Нижегородские IT-компании смогут побороться за победу во всероссийском конкурсе «IT-проект: Back To The Product»
03 Июня
СМИ о нас  
Скидки и сертификаты стали доступны на «Карте жителя Нижегородской области»
01 Июня
СМИ о нас  
Фестиваль детских инновационных проектов прошел в технопарке «Кванториум Нижний Новгород»
26 Мая
СМИ о нас  
Нижегородские школьники разработали маску дополненной реальности для сервиса «Карта жителя Нижегородской области»
20 Мая
СМИ о нас  
Как интегратор 1С балуется плюшками
17 Мая
СМИ о нас  
Историческая викторина в честь 800-летия Нижнего Новгорода стартовала на “Карте жителя”
12 Мая
СМИ о нас  
Жители региона смогут получать цифровые квитанции через сервис «Карта жителя Нижегородской области
12 Мая
СМИ о нас  
Квитанции об оплате услуг ЖКХ можно получить на портале «Карта жителя»
27 Апреля
СМИ о нас  
Джентльменский набор приложений для смартфона в 2021 году
23 Апреля
СМИ о нас  
IT-компания Lad вошла в число крупнейших работодателей рынка IT в Нижнем Новгороде
16 Апреля
СМИ о нас  
Какой кошелек выбрать?
05 Апреля
СМИ о нас  
Формы платформы
04 Апреля
СМИ о нас  
На 30% Минстрой России прогнозирует повышение индекса IQ городов к 2024 году
01 Апреля
СМИ о нас  
К 2024 году в России планируется на 30% повысить индекс цифровизации городов
22 Марта
СМИ о нас  
Эко-квест «800 шагов к чистому городу»
18 Марта
СМИ о нас  
Все школы в России обеспечат доступом к интернету в этом году
06 Марта
СМИ о нас  
Команды из Нижегородской области стали победителями межрегионального онлайн-хакатона
06 Марта
СМИ о нас  
Кейс «Instagram-маски в честь 800-летия Нижнего Новгорода» от IT-компании Lad
01 Марта
СМИ о нас  
Где работать в ИТ в 2021: Lad
28 Февраля
СМИ о нас  
Нижегородский онлайн-хакатон «VRARHack52» соберет юных разработчиков со всей страны
22 Февраля
СМИ о нас  
Диагностируем проблемы в микросервисной архитектуре на Node.js с помощью OpenTracing и Jaeger
25 Декабря
СМИ о нас  
В российских школах заменяют Word и Excel на отечественные аналоги
24 Декабря
СМИ о нас  
Дмитрий Петров о налоговых льготах для IT-сферы
СМИ о нас  
Нижегородские IT-компании получат налоговые льготы
22 Декабря
СМИ о нас  
Профит для бизнеса от работы контактного центра на удаленке: кейс компании Lad
10 Декабря
СМИ о нас  
Росатом интегрирует решения российских разработчиков в проекты Smart City
07 Декабря
СМИ о нас  
Портал "Карта жителя Нижегородской области" стал удобнее
06 Декабря
СМИ о нас  
На портале «Карта жителя Нижегородской области» обновлен профиль пользователя
30 Ноября
СМИ о нас  
iCluster обсудит лучшие практики импортозамещения
27 Ноября
СМИ о нас  
Lad: цифровая трансформация бизнеса
19 Ноября
СМИ о нас  
IT-компания Lad поделится лучшими практиками
18 Ноября
СМИ о нас  
Компания Lad проведет день открытых дверей и расскажет о трендах IT-разработки
14 Ноября
СМИ о нас  
Участники регионального iCluster расскажут об отраслевых трендах
29 Октября
СМИ о нас  
О будущем проекта "Карта жителя Нижегородской области"
22 Октября
СМИ о нас  
Эксперт Lad дал комментарий Tadviser об импортозамещении офисного софта
14 Октября
СМИ о нас  
Как ИТ-специалисту устроиться на работу в хорошую компанию
07 Октября
СМИ о нас  
Карту жителя Нижегородской области начнут тестировать в октябре
06 Октября
СМИ о нас  
К сервису «Карта жителя Нижегородской области» присоединились первые банки-партнеры
01 Октября
СМИ о нас  
Пакет офисных решений "Р7-Офис" поступит в школы Ингушетии
01 Октября
СМИ о нас  
Ингушетия получит 3 тыс. лицензий на российское ПО для системы образования
25 Августа
СМИ о нас  
НБД-Банк и IT-компания Lad предлагают малому бизнесу онлайн-кассы в аренду
18 Июня
СМИ о нас  
Алтайский край переходит на российское ПО
06 Мая
СМИ о нас  
Work must go on!
03 Апреля
СМИ о нас  
IT-компании предлагают свои продукты бесплатно
26 Марта
СМИ о нас  
ПСС на Digital.Forum Construction 2020
24 Марта
СМИ о нас  
Быстрая цифровизация строительной отрасли
16 Марта
СМИ о нас  
Партнерская акция IT-компании Lad и НБД-Банка
13 Февраля
СМИ о нас  
Отечественное ПО для белгородских школьников
СМИ о нас  
Платформа HiBrain - разработка IT-компании Lad
СМИ о нас  
Digital Summit 2019
24 Октября
СМИ о нас  
В Нижнем Новгороде iCluster провёл IT-фестиваль "iFest 2019"
21 Октября
СМИ о нас  
Lad на фестивале программистов IFest
03 Октября
СМИ о нас  
Обрабатываем заказы из интернет магазина с помощью RabbitMQ и TypeScript
27 Сентября
СМИ о нас  
Lad примет участие в Digital Summit 2019
СМИ о нас  
Как IT-технологии изменили жизнь нижегородцев?
06 Августа
СМИ о нас  
В Нижегородской области запустят ПСС
07 Июня
СМИ о нас  
На ПМЭФ презентованы проекты IT-компании Lad
06 Июня
СМИ о нас  
На ПМЭФ презентованы ключевые нижегородские ИТ проекты
29 Мая
СМИ о нас  
В Нижнем Новгороде запустили цифровую платформу IT-образования HiBrain
24 Апреля
СМИ о нас  
Kari втрое ускорила оформление рассрочки
12 Февраля
СМИ о нас  
Цифровизация Retail-отрасли: актуальные тренды
23 Ноября
СМИ о нас  
Лучшие IT-проекты выбрали в Нижнем Новгороде
Поделитесь вашим мнением
Ответ успешно отправлен Мы свяжемся с вами в ближайшее время

Файлы cookies

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

подробнее хорошо