СМИ о нас
Почему обучение
технического писателя — это
нетривиальная задача
#IT
Время чтения: 7 мин 9 сек
07 Октября 2021
#IT
Поделиться статьей
Подпишитесь на рассылку
Рассказывают технические писатели IT-компании Lad Екатерина Каляева, Анна Назолина, Ксения Скорынина.
На динамичном IT-рынке сложно оставаться в стороне от тренда на самообразование. И если для разработчиков многие компании предлагают зрелые, выстроенные траектории развития, то для большинства технических писателей такая опция пока недоступна.

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

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

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

  • сильные навыки коммуникации;
  • умение быстро разбираться в сложных технологиях и концепциях;
  • hard skills по работе с техническими текстами.
Таким образом, технический писатель — это мост между разными аудиториями. Он умеет найти подход к людям с разными темпераментами, обладает большим объёмом «оперативной памяти», умеет вычленять из потока информации главное и ставить вопросы, чтобы закрыть пробелы в знаниях. Благодаря этим качествам технический писатель может глубоко понять цели технического текста и сделать его корректным, полным и эффективным.

На минимальных требованиях, конечно, никто не останавливается, поэтому и мы добавим к ним несколько hard skills.

1. Опыт работы с общими для IT корпоративными инструментами (Jira, YouTrack, Slack, Gitlab).
2. Навыки работы с инструментами, позволяющими строить схемы, диаграммы (например, diagram.net, Lucidchart).

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

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

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

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

Однако, даже зная, где искать материалы для обучения, важно выбирать только релевантное и отсеивать ненужное. Почему сложно подобрать курс по документированию? Многие существующие на рынке варианты работают как введение в профессию или фокусируются на разработке документации по ГОСТ. Действительно стоящие и крутые курсы плохо гуглятся: их анонсируют в тех же telegram-каналах.

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

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

  • Ю.В. Кагарлицкий. Разработка документации пользователя программного продукта. Методика и стиль изложения.

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

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

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

  • Александр Орлов. Джедайские техники конструктивного общения.

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

1. Найти единомышленников. Пусть это будут не техписатели, а аналитики, project- и product-менеджеры, QA-инженеры. Важно чувствовать, что ты можешь обсудить свои профессиональные вопросы с кем-то и получить поддержку и тезисы для размышлений. Например, мы организовали сотрудничество с гильдией аналитиков. Встречаемся раз в месяц и обсуждаем общие темы, из последнего: как готовить схемы в разных нотациях.

2. Если не удаётся найти коллег по цеху внутри компании, можно поискать вовне. Например, есть русскоязычный чат в Telegram, где состоит около двух тысяч человек, так или иначе связанных с техписательством. Другой вариант: англоязычный Slack техрайтеров со всего мира writethedocs.slack.com. В них можно найти анонсы профессиональных мероприятий, задать вопрос по рабочим процессам и инструментам, найти ментора, если нужна консультация или обучение 1 на 1.

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

4. Вести «дневник побед». Звучит забавно, но мотивирует продолжать развитие, даже если пока не с кем этим поделиться. Работать с ним просто: каждый день выделяйте 5 минут ближе к концу рабочего дня, чтобы вспомнить и записать, какие челленджи вы сегодня решили или к каким большим и долгосрочным задачам подступили. Фокус должен быть на новых для вас подходах и методах, а также на результатах, которые имеют реальный профит для вашей компании, людей и процессов в ней.
Что в итоге?
В настоящее время работа техническим писателем привлекает много внимания. С каждым годом должность становится более актуальной и востребованной (среди молодого поколения). Однако обучение профессии не является простым линейным и требует дополнительных усилий в подборе подходящих источников для обучения и развития навыков.

Зная, какие soft- и hard-скиллы необходимы в работе технического писателя, а также обладая упорством и пониманием того, где искать проверенные материалы, можно максимально усовершенствовать свои профессиональные навыки и стать незаменимым сотрудником компании.
ИСТОЧНИК: https://tproger.ru/articles/pochemu-obuchenie-tehnicheskogo-pisatelja-jeto-netrivialnaja-zadacha
Другие статьи из раздела СМИ о нас
16 Ноября
СМИ о нас  
Победители исторической викторины “Знаешь город?” получили награды
28 Октября
СМИ о нас  
На Forum.Digital Smart City 2021 обсудили перспективы проекта Минстроя России «Умный город»
23 Октября
СМИ о нас  
В Нижнем Новгороде подвели итоги всероссийского конкурса «IT-проект: Back To The Product»
23 Октября
СМИ о нас  
Доля цифровых технологий в экономике Нижегородской области составляет 10%
12 Октября
СМИ о нас  
Как я сжимал модель FastText для реальной задачи в 80 раз в 2021 году
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-разработчиков
06 Июля
СМИ о нас  
Технический писатель: с чего начать
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. Это необходимо для анализа трафика и корректной работы сайта. Продолжая работу с сайтом, вы подтверждаете свое согласие на применение этих технологий.

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