А у нас новая статья в блоге на Хабре:

Регулярные выражения для технических писателей и не только

Нет-нет, это не про те выражения, которые регулярно произносит вслух техписатель, не укладывающийся в дедлайн. Регулярные выражения (regular expressions) — это мощный инструмент замены фрагментов текста, который «из коробки» поддерживается в вашем любимом текстовом редакторе.

(да, мы знаем, что в интернете есть миллион гайдов по регэкспам, но согласитесь, гораздо приятнее прочитать или отправить коллеге-новичку статью, написанную техписателями и для техписателей)

Пройдите большой документационный опрос от documentat.io!

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

Этим опросом мы хотим узнать:

🔹 Кто мы, русскоязычные техписатели? Из каких профессиональных бэкграундов мы пришли в документацию? Мы преимущественно технари или гуманитарии? Каков наш средний возраст?
🔹 Каковы типичные зарплаты техписателей в России? Как они зависят от региона, используемого инструментального стека, индустрии, размера компании? Есть ли в нашей профессии зарплатный разрыв между женщинами и мужчинами?
🔹 Что мы пишем? Какой процент русскоязычных техписателей пишет только по ГОСТ? Как часто нам приходится документировать API?
🔹 Какими инструментами мы пользуемся? Все ли уже переехали на docs-as-code? Все ли отказались от Confluence?

Анализ результатов опроса будет опубликован в телеграм-канале @documentatio_official и в нашем блоге на Хабре.

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

Чуть больше подробностей о формате и длине опроса: https://news.1rj.ru/str/technicalwriters/151647

Сам опрос: https://forms.gle/ry1HbL3twnToVruP9

Наш большой документационный опрос прошли уже 330 человек, пройдите его и вы!

Наша оптимистичная цель — 1000 респондентов, будем рады, если вы нам поможете😊

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

https://habr.com/ru/companies/documentat/articles/784916/

Наш большой документационный опрос продолжается!

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

Опрос открыт до 31 января: пожалуйста, пройдите его сами и перешлите его своим коллегам!

Анкета опроса: https://forms.gle/ry1HbL3twnToVruP9

Чуть больше подробностей: https://habr.com/ru/companies/documentat/articles/784916/

А вот и первые курсы documentat.io в новом сезоне:

❇️ Управляем командой технических писателей: двухдневный семинар для техписателей-тимлидов и тех, кто готовится к этой роли. Масштабирование команды, профессиональный рост подчиненных, делегирование задач, настройка процессов, отбор и наем техписателей. 31 января — 2 февраля 2024.

❇️ Экспресс-курс «Технический писатель»: короткий вводный курс для желающих начать карьеру техписателя. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. Каждый участник курса сможет написать несколько технических документов и получить по ним комментарии преподавателей. Ближайший курс пройдет 20–29 февраля 2024, еще одна группа будет набрана на апрель—май.

❇️ Advanced Technical Writing: курс для практикующих техписателей. Теоретические занятия о качестве документации, процессах документирования и карьере техписателя. Много практических заданий о паттернах изложения технической информации. Ближайший курс пройдет 13–22 марта 2024, еще одна группа будет набрана на апрель–май.

❇️ Большой курс по ГОСТ для опытных техписателей, которые пока еще не погружались в ГОСТ, но текущая рабочая обстановка начинает этого требовать. Курс пройдет весной 2024, пока идет предварительная запись и изучение спроса.

❇️ Документация разработки: курс о документации, которая пишется разработчиками и адресована разработчикам: справочники API, фиксация архитектурных решений (ADR), документирование программного дизайна и программной архитектуры (C4, arc42). Курс проводится только для корпоративных групп и только по запросу.

❇️ Бесплатный обзорный курс о технической документации: 12 лекций от представителей российского сообщества техписателей на разные темы: процессы документирования, инструментарий техписателя, docs-as-code, локализация, ГОСТ 19 и ГОСТ 34. Лекции курса доступны в YouTube-плейлисте или в телеграм-чате курса.

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

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

Спонсорский контент!!111

Всякие интересные инициативы от наших друзей и знакомых:

🔸Таня Фокина, UX-писатель и автор канала «Таня прочитала», проводит зарплатный опрос русскоязычных UX-писателей. Если вы занимаетесь задачами, связанными с текстами в UI, то поучаствуйте в опросе!

🔸Очередная конференция об управлении знаниями KnowledgeConf пройдет в июне 2024 в Санкт-Петербурге. 1 февраля 2024 оргкомитет конференции собирает онлайн-встречу с потенциальными докладчиками и всеми интересующимися. Участие в KnowledgeConf — отличный способ поделиться с сообществом вашими наработками в области организации баз знаний, ускорения онбординга, настройки процессов документирования и пр.

И не забывайте про наш большой документационный опрос! Он открыт до 31 января.

В конце января мы завершили наш большой документационный опрос.

Огромное спасибо всем, кто уделил ему время!

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

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

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

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

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

Напоминаю, что среди согласившихся на интервью мы разыграем (на выбор каждого выигравшего) промокод на скидку в 100% на любой курс documentat.io или подарочный сертификат в Ozon/Wildberries или любой другой онлайн-магазин в вашей локации.

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

На этот раз мы говорим о том, как адресовать свою документацию глобальной, non-native аудитории.

(да, речь в статье идет в том числе о Simplified Technical English и Global English)

Ставьте плюсики и подписывайтесь на наш хабраблог! Итоги нашего большого соцопроса будут опубликованы там уже в этом месяце.

Опубликовали на Хабре веселую статью о документации, адресованную начинающим IT-специалистам.

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

А вот!

А у нас новый учебный курс, на этот раз о ревью.

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

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

В практической части курса мы проведем ревью фрагмента вашей документации по стандартам documentat.io.

27 мая — 6 июня 2024, онлайн.

Это тестовая группа, в ней всего 10 мест, поэтому успевайте записаться!

https://documentat.io/courses/review/

А вот и расписание курсов documentat.io на весь 2024 год.

Внимательные читатели найдут здесь целых три(!) новых курса.

❇️ Ревью документации: методы, приемы, процессы. Поговорим о видах ревью, о процессах вокруг него, об этикете и человеческой стороне проверки качества документации. В практической части курса разберем характерные проблемы технических текстов и проведем ревью вашего фрагмента документации. 27 мая – 6 июня 2024

❇️ Большой курс по ГОСТ. Полное погружение в ГОСТ для тех, кто с ним еще не сталкивался. Расскажем, чем работа по ГОСТ отличается от других техписательских задач. Научим писать и сдавать ГОСТ-комплекты документации. 25 июня — 5 июля 2024, еще одна группа будет набрана на декабрь 2024.

❇️ Документация API. Расскажем о принципах REST API, о современном инструментарии документирования API и о взаимодействии техписателя и команды разработки. Попрактикуемся в описании реального API с помощью Swagger. 5–16 августа 2024

❇️ Управляем командой технических писателей: семинар для техписателей-тимлидов и тех, кто готовится к этой роли. Масштабирование команды, профессиональный рост подчиненных, делегирование задач, настройка процессов, отбор и наем техписателей. 16–20 сентября 2024.

❇️ Экспресс-курс «Технический писатель»: короткий вводный курс для желающих начать карьеру техписателя. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. Каждый участник курса сможет написать несколько технических документов и получить по ним комментарии преподавателей. 24 сентября — 3 октября 2024, еще одна группа будет набрана на январь 2025.

❇️ Документация разработки: курс о документации, которая пишется разработчиками и адресована разработчикам: фиксация архитектурных решений (ADR), документирование программного дизайна и программной архитектуры (C4, arc42). Курс проводится только для корпоративных групп и только по запросу.

❇️ Бесплатный обзорный курс о технической документации: 12 лекций от представителей российского сообщества техписателей на разные темы: процессы документирования, инструментарий техписателя, docs-as-code, локализация, ГОСТ 19 и ГОСТ 34. Лекции курса доступны в YouTube-плейлисте или в телеграм-чате курса.

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

За выходные мы укомплектовали группы на бóльшую часть только что анонсированных курсов. Спасибо вам за активный интерес к тому, что мы делаем!

Сейчас у нас открыта запись только на эти курсы:

❇️ Ревью документации: методы, приемы, процессы. Поговорим о видах ревью, о процессах вокруг него, об этикете и человеческой стороне проверки качества документации. В практической части курса разберем характерные проблемы технических текстов и проведем ревью вашего фрагмента документации. 27 мая – 6 июня 2024

❇️ Управляем командой технических писателей: семинар для техписателей-тимлидов и тех, кто готовится к этой роли. Масштабирование команды, профессиональный рост подчиненных, делегирование задач, настройка процессов, отбор и наем техписателей. 16–20 сентября 2024.

Если вы ранее оставляли заявки на какие-либо из наших курсов (включая те, на которые набор уже закрыт), наши менеджеры обязательно свяжутся с вами в течение этой недели.

Если на каком-то из укомплектованных курсов освободятся места, мы немедленно анонсируем это в телеграм-канале @documentatio_official.

Наша статья про английский язык победила в номинации «Подготовка технической документации» конкурса «Технотекст 2023»!

Поздравляем автора статьи Костю Макушева!

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

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

- В каких странах и городах мы живем?
- Сколько нам лет?
- Кого среди нас больше — мужчин или женщин?
- Сколько мы зарабатываем?

https://habr.com/ru/companies/documentat/articles/818199/

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

Не получилось ли так, что авторы опроса (я и documentat.io) планируют использовать эти величины для манипуляции рынком труда и для занижения зарплат в техписательских вакансиях?

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

Пост ответов на незаданные вопросы Юрия

Удивили ли меня результаты опроса в части зарплат?
Да я просто оху Очень удивили, да. Я был уверен, что медиана (особенно в регионах) выше.

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

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

Картельный сговор тут не работает никаким образом — всем выгодно максимизировать собственный наём в ущерб найму в компаниях-конкурентах, В чистом виде zero-sum game.

Факторович подрихтовал результаты опроса! Зарплаты на самом деле выше!
См. выше, делать так — подвергать риску мой собственный наём

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

Права техписателей с зарплатами в 200к+ ущемляют, теперь их будут прогибать по зарплатам!
Поверьте мне, у техписателей с зарплатами из 95-го процентиля всё хорошо: их активно хантят и перекупают, если они выходят на рынок труда, за ними выстраивается очередь работодателей, у них нет проблем с повышением ЗП на текущем месте работы. Опять же, в игре «найми сеньора» никому из работодателей нет смысла занижать зарплаты в ущерб собственной конкурентоспособности. Сеньоров на рынке такой дефицит, что работодатели готовы удерживать и привлекать их каким угодно способом.

Чьи права ущемляют, так это техписателей из регионов с зарплатами 90к и меньше (а их почти 50%, на секундочку). Именно эти техписатели должны показывать эту статью своим работодателям. Именно работодатели, нанимающие в регионах, должны корректировать свою зарплатную политику, чтобы быть конкурентными хотя бы в терминах «мы платим на 10% выше медианы Факторовича» — потому что это уже будет выше половины их текущего рынка.

Поэтому, дорогие мои сеньоры с зарплатой в 300кк/сек, этот опрос вообще не про вас. Этот опрос про ту часть техписательского сообщества, которая получает ниже медианы (еще раз: их ровно половина из всех опрошенных, в этом и определение медианы, и здесь уже даже не столь важно, насколько репрезентативна моя выборка). И одна из целей опроса — поднимать эту медиану год к году. В этом году умные работодатели в регионах увидят эту статистику и поднимут свои зарплаты на 10%-15%-20%. В следующем году опрос покажет, что медиана выросла до, условно, 140к, и работодателям снова придется повышать ее, чтобы оставаться конкурентными.

Зачем это всё мне? Потому что моя миссия — создавать и растить профсообщество техписателей. Сейчас нас мало и мы растем не так хорошо, как хотелось бы: мало людей приходит в профессию, много уходит в другие профессии. Работа с зарплатным рынком — один из способов оздоровить и расширить сообщество (один из, не единственный). И да, мой аутсорсный бизнес — всего лишь одна из активностей, которыми я в этом сообществе занимаюсь.

А вот и вторая статья о результатах нашего техписательского опроса.

На этот раз мы расскажем вот о чем:

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

https://habr.com/ru/companies/documentat/articles/819633/

Пожалуйста, выступайте на конференциях!

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

Вот две прекрасные российские конференции, где всегда рады докладам от техписателей:

🔹KnowledgeConf, 27–28 ноября 2024, Москва

🔹TechWriter Days, 28–29 марта 2025, Санкт-Петербург

На обе из них еще можно подавать заявки на доклады, но дедлайны уже близки: у KnowledgeConf крайний срок подачи 15 августа, у TechWriter Days — 1 сентября.

Если вы ждали знака, чтобы попробовать впервые выступить, то это он:) Рассказать о своих профессиональных достижениях и поделиться опытом с другими техписателями — что может быть интереснее?

А в качестве дополнительного стимула вот вам запись моего доклада на KnowledgeConf'23