Всем привет, на связи documentat.io.

С 2016 года мы помогаем российским IT-компаниям создавать качественную техническую документацию.

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

Приходите к нам! documentat.io

Мы (documentat.io) понемногу формируем расписание курсов на осень и зиму.

❇️ Экспресс-курс «Технический писатель»: маленький вводный курс для тех, кто пока еще не знаком с профессией. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. 26 сентября — 4 октября 2023.

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

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

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

Приходите к нам! documentat.io/courses

Первый курс от documentat.io в этом сезоне стартует уже на следующей неделе!

❇️ Экспресс-курс «Технический писатель»: маленький вводный курс для тех, кто пока еще не знаком с профессией. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. 26 сентября — 4 октября 2023.

Курс будет повторен 7–16 ноября 2023.

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

Теперь у documentat.io есть блог на Хабре!

Встречайте нашу первую статью:

Diátaxis: структура технической документации

Пусть малознакомое греческое слово и диакритика над буквой A вас не пугают:) Diátaxis — это несложный подход к жанровому делению документации, адресованной разработчикам.

Ждем ваших комментариев, голосов за статью и плюсиков в карму!

Следите за новыми статьями и анонсами курсов в нашем канале @documentatio_official.

Таня Фокина, UX-писатель и (не побоимся громкого слова!) евангелист этого профессионального направления записала уютный подкаст с Семёном Факторовичем.

Обстоятельную беседу о сходствах и различиях технических писателей и UX-писаталей, а также о том, как начать карьеру в одном из этих направлений можно послушать вот здесь:

https://youtu.be/d6t1Hhnq7Dc

Танин канал о UX writing: @rishavant

Канал новостей documentat.io: @documentatio_official

И в канале появляются комментарии!

Небольшое обновление расписания курсов documentat.io в этом сезоне:

❇️ Экспресс-курс «Технический писатель»: маленький вводный курс для тех, кто пока еще не знаком с профессией. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. 7–16 ноября 2023.

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

❇️ Курс по документированию API пока в разработке, надеемся запустить его до конца года.

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

Вчера к нам в гости приходил Коля Поташников с рассказом о современном состоянии docops-инструментария.

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


Из неожиданных выводов:

- Pandoc всё еще главный «швейцарский нож» процессинга документов, ничего лучше пока не появилось.

- Генерить DOCX (особенно с TOC и колонтитулами) всё еще сложно, вам почти наверняка понадобится пре- и пост-процессинг AST документа. Вариант чуть упростить себе жизнь — генерить ODT и уже потом конвертировать его в DOCX.

- LaTeX — не единственный способ программной генерации PDF: в 2023 вполне рабочим вариантом стала генерация PDF из HTML с помощью WeasyPrint, https://github.com/Kozea/WeasyPrint

Это Оксана, ведущая нашего экспресс-курса для технических писателей.

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

И это было здорово!

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

Порадуйте Оксану, приходите на ее ноябрьский курс!

❇️ Экспресс-курс «Технический писатель»: маленький вводный курс для тех, кто пока еще не знаком с профессией. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. 7–16 ноября 2023.

Тем временем documentat.io продолжает транслировать свою профессиональную мудрость в блог на Хабре.

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

И получилось очень по-техписательски! Емко, без воды, логично и с хорошей структурой.

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

🔹Как улучшить английский в документации. Часть 1: грамматический ликбез

🔹Как улучшить английский в документации. Часть 2: ловушки двусмысленности

Подписывайтесь на наш канал @documentatio_official, чтобы следить за новыми статьями и учебными материалами!

30 ноября и 1 декабря в Москве проходит TeamLeadConf, самая крупная российская конференция для руководителей разработки.

В этом году в рамках TeamLeadConf и на той же площадке также проходит KnowledgeConf, конференция об управлении знаниями.

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

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

30 ноября (в четверг) в 16:20 Мск Семён Факторович рассказывает о том, как руководители команд разработки применяют документацию себе на благо и во вред, и этот доклад доступен в бесплатной трансляции.

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

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

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

Нет-нет, это не про те выражения, которые регулярно произносит вслух техписатель, не укладывающийся в дедлайн. Регулярные выражения (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 или любой другой онлайн-магазин в вашей локации.