Всем привет, на связи 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, чтобы следить за новыми статьями и учебными материалами!