Всем привет, на связи documentat.io.
С 2016 года мы помогаем российским IT-компаниям создавать качественную техническую документацию.
🔹 Пишем документацию на заказ: по ГОСТ и не по ГОСТ, для пользователей и разработчиков, внутреннюю и внешнюю, на русском и английском.
🔹 Расширяем и усиливаем документационные команды через аутстаффинг.
🔹 Помогаем в настройке процессов документирования.
🔹 Внедряем новые инструменты хранения и публикации документации.
🔹 Учим техписателей и разработчиков писать документацию.
Приходите к нам! documentat.io
С 2016 года мы помогаем российским IT-компаниям создавать качественную техническую документацию.
🔹 Пишем документацию на заказ: по ГОСТ и не по ГОСТ, для пользователей и разработчиков, внутреннюю и внешнюю, на русском и английском.
🔹 Расширяем и усиливаем документационные команды через аутстаффинг.
🔹 Помогаем в настройке процессов документирования.
🔹 Внедряем новые инструменты хранения и публикации документации.
🔹 Учим техписателей и разработчиков писать документацию.
Приходите к нам! documentat.io
Мы (documentat.io) понемногу формируем расписание курсов на осень и зиму.
❇️ Экспресс-курс «Технический писатель»: маленький вводный курс для тех, кто пока еще не знаком с профессией. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. 26 сентября — 4 октября 2023.
❇️ «Управляем командой технических писателей»: двухдневный семинар для техписателей-тимлидов и тех, кто готовится к этой роли. Масштабирование команды, профессиональный рост подчиненных, делегирование задач, настройка процессов, отбор и наем техписателей. 31 января — 2 февраля 2024.
❇️ Advanced Technical Writing: курс для практикующих техписателей. Теоретические занятия о качестве документации, процессах документирования и карьере техписателя. Много практических заданий о паттернах изложения технической информации. Даты пока уточняются.
Все курсы проходят онлайн в формате живых вебинаров. Участникам будут доступны видеозаписи и все материалы занятий.
Приходите к нам! documentat.io/courses
❇️ Экспресс-курс «Технический писатель»: маленький вводный курс для тех, кто пока еще не знаком с профессией. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. 26 сентября — 4 октября 2023.
❇️ «Управляем командой технических писателей»: двухдневный семинар для техписателей-тимлидов и тех, кто готовится к этой роли. Масштабирование команды, профессиональный рост подчиненных, делегирование задач, настройка процессов, отбор и наем техписателей. 31 января — 2 февраля 2024.
❇️ Advanced Technical Writing: курс для практикующих техписателей. Теоретические занятия о качестве документации, процессах документирования и карьере техписателя. Много практических заданий о паттернах изложения технической информации. Даты пока уточняются.
Все курсы проходят онлайн в формате живых вебинаров. Участникам будут доступны видеозаписи и все материалы занятий.
Приходите к нам! documentat.io/courses
Первый курс от documentat.io в этом сезоне стартует уже на следующей неделе!
❇️ Экспресс-курс «Технический писатель»: маленький вводный курс для тех, кто пока еще не знаком с профессией. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. 26 сентября — 4 октября 2023.
Курс будет повторен 7–16 ноября 2023.
Чтобы следить за расписанием наших курсов и за свежими вакансиями, подписывайтесь на наш канал @documentatio_official.
❇️ Экспресс-курс «Технический писатель»: маленький вводный курс для тех, кто пока еще не знаком с профессией. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. 26 сентября — 4 октября 2023.
Курс будет повторен 7–16 ноября 2023.
Чтобы следить за расписанием наших курсов и за свежими вакансиями, подписывайтесь на наш канал @documentatio_official.
Теперь у documentat.io есть блог на Хабре!
Встречайте нашу первую статью:
Diátaxis: структура технической документации
Пусть малознакомое греческое слово и диакритика над буквой A вас не пугают:) Diátaxis — это несложный подход к жанровому делению документации, адресованной разработчикам.
Ждем ваших комментариев, голосов за статью и плюсиков в карму!
Следите за новыми статьями и анонсами курсов в нашем канале @documentatio_official.
Встречайте нашу первую статью:
Diátaxis: структура технической документации
Пусть малознакомое греческое слово и диакритика над буквой A вас не пугают:) Diátaxis — это несложный подход к жанровому делению документации, адресованной разработчикам.
Ждем ваших комментариев, голосов за статью и плюсиков в карму!
Следите за новыми статьями и анонсами курсов в нашем канале @documentatio_official.
👍9👏4🔥2
Таня Фокина, UX-писатель и (не побоимся громкого слова!) евангелист этого профессионального направления записала уютный подкаст с Семёном Факторовичем.
Обстоятельную беседу о сходствах и различиях технических писателей и UX-писаталей, а также о том, как начать карьеру в одном из этих направлений можно послушать вот здесь:
https://youtu.be/d6t1Hhnq7Dc
Танин канал о UX writing: @rishavant
Канал новостей documentat.io: @documentatio_official
Обстоятельную беседу о сходствах и различиях технических писателей и UX-писаталей, а также о том, как начать карьеру в одном из этих направлений можно послушать вот здесь:
https://youtu.be/d6t1Hhnq7Dc
Танин канал о UX writing: @rishavant
Канал новостей documentat.io: @documentatio_official
YouTube
О технических писателях с Семёном Факторовичем
Упоминались в подкасте
Компания Семёна: documentat.io/?utm_source=ux_channel
Онлайн-курсы Семёна: documentat.io/courses/?utm_source=ux_channel
Книга "The Product is Docs" про современный комплексный взгляд на документацию: https://www.amazon.com/Product…
Компания Семёна: documentat.io/?utm_source=ux_channel
Онлайн-курсы Семёна: documentat.io/courses/?utm_source=ux_channel
Книга "The Product is Docs" про современный комплексный взгляд на документацию: https://www.amazon.com/Product…
👍10🔥1
Небольшое обновление расписания курсов documentat.io в этом сезоне:
❇️ Экспресс-курс «Технический писатель»: маленький вводный курс для тех, кто пока еще не знаком с профессией. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. 7–16 ноября 2023.
❇️ Advanced Technical Writing: курс для практикующих техписателей. Теоретические занятия о качестве документации, процессах документирования и карьере техписателя. Много практических заданий о паттернах изложения технической информации. Этой осенью курса не будет. Пока планируем его в феврале–марте 2024.
❇️ Курс по документированию API пока в разработке, надеемся запустить его до конца года.
Чтобы следить за расписанием наших курсов и за свежими вакансиями, подписывайтесь на наш канал @documentatio_official.
❇️ Экспресс-курс «Технический писатель»: маленький вводный курс для тех, кто пока еще не знаком с профессией. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. 7–16 ноября 2023.
❇️ Advanced Technical Writing: курс для практикующих техписателей. Теоретические занятия о качестве документации, процессах документирования и карьере техписателя. Много практических заданий о паттернах изложения технической информации. Этой осенью курса не будет. Пока планируем его в феврале–марте 2024.
❇️ Курс по документированию API пока в разработке, надеемся запустить его до конца года.
Чтобы следить за расписанием наших курсов и за свежими вакансиями, подписывайтесь на наш канал @documentatio_official.
👍10🔥3
Вчера к нам в гости приходил Коля Поташников с рассказом о современном состоянии docops-инструментария.
Доклад получился потрясающе интересным, планируем в ближайшие месяцы провести его в виде вебинара на большую аудиторию.
Из неожиданных выводов:
- Pandoc всё еще главный «швейцарский нож» процессинга документов, ничего лучше пока не появилось.
- Генерить DOCX (особенно с TOC и колонтитулами) всё еще сложно, вам почти наверняка понадобится пре- и пост-процессинг AST документа. Вариант чуть упростить себе жизнь — генерить ODT и уже потом конвертировать его в DOCX.
- LaTeX — не единственный способ программной генерации PDF: в 2023 вполне рабочим вариантом стала генерация PDF из HTML с помощью WeasyPrint, https://github.com/Kozea/WeasyPrint
Доклад получился потрясающе интересным, планируем в ближайшие месяцы провести его в виде вебинара на большую аудиторию.
Из неожиданных выводов:
- Pandoc всё еще главный «швейцарский нож» процессинга документов, ничего лучше пока не появилось.
- Генерить DOCX (особенно с TOC и колонтитулами) всё еще сложно, вам почти наверняка понадобится пре- и пост-процессинг AST документа. Вариант чуть упростить себе жизнь — генерить ODT и уже потом конвертировать его в DOCX.
- LaTeX — не единственный способ программной генерации PDF: в 2023 вполне рабочим вариантом стала генерация PDF из HTML с помощью WeasyPrint, https://github.com/Kozea/WeasyPrint
❤12🔥8
Это Оксана, ведущая нашего экспресс-курса для технических писателей.
Она совсем недавно завершила работу с октябрьской группой этого курса: прочитала четыре лекции, ответила на сотню вопросов от слушателей, вместе с командой помощников проверила несколько десятков домашних заданий.
И это было здорово!
Как и любой хороший преподаватель, основную часть удовольствия от своей работы Оксана находит в общении с мотивированными и заинтересованными слушателями.
Порадуйте Оксану, приходите на ее ноябрьский курс!
❇️ Экспресс-курс «Технический писатель»: маленький вводный курс для тех, кто пока еще не знаком с профессией. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. 7–16 ноября 2023.
Она совсем недавно завершила работу с октябрьской группой этого курса: прочитала четыре лекции, ответила на сотню вопросов от слушателей, вместе с командой помощников проверила несколько десятков домашних заданий.
И это было здорово!
Как и любой хороший преподаватель, основную часть удовольствия от своей работы Оксана находит в общении с мотивированными и заинтересованными слушателями.
Порадуйте Оксану, приходите на ее ноябрьский курс!
❇️ Экспресс-курс «Технический писатель»: маленький вводный курс для тех, кто пока еще не знаком с профессией. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. 7–16 ноября 2023.
😍8❤4🤝3🔥2👍1
Тем временем documentat.io продолжает транслировать свою профессиональную мудрость в блог на Хабре.
Наш техписатель Костя Макушев, в прошлом технический переводчик, решил посмотреть на английскую грамматику через призму техписательской системности изложения.
И получилось очень по-техписательски! Емко, без воды, логично и с хорошей структурой.
(что еще раз доказывает, что хорошему техписателю совершенно неважно, какую предметную область описывать — хоть программный продукт, хоть живой язык).
🔹Как улучшить английский в документации. Часть 1: грамматический ликбез
🔹Как улучшить английский в документации. Часть 2: ловушки двусмысленности
Подписывайтесь на наш канал @documentatio_official, чтобы следить за новыми статьями и учебными материалами!
Наш техписатель Костя Макушев, в прошлом технический переводчик, решил посмотреть на английскую грамматику через призму техписательской системности изложения.
И получилось очень по-техписательски! Емко, без воды, логично и с хорошей структурой.
(что еще раз доказывает, что хорошему техписателю совершенно неважно, какую предметную область описывать — хоть программный продукт, хоть живой язык).
🔹Как улучшить английский в документации. Часть 1: грамматический ликбез
🔹Как улучшить английский в документации. Часть 2: ловушки двусмысленности
Подписывайтесь на наш канал @documentatio_official, чтобы следить за новыми статьями и учебными материалами!
👍15🔥5❤🔥1
30 ноября и 1 декабря в Москве проходит TeamLeadConf, самая крупная российская конференция для руководителей разработки.
В этом году в рамках TeamLeadConf и на той же площадке также проходит KnowledgeConf, конференция об управлении знаниями.
Техническая документация — очевидное подмножество области управления знаниями, поэтому на KnowledgeConf традиционно выступают представители нашего техписательского сообщества.
Отличные новости в том, что организаторы TeamLeadConf решили сделать бесплатную онлайн-трансляцию основного трека, и у всех желающих будет возможность послушать отличные доклады о документации и не только!
30 ноября (в четверг) в 16:20 Мск Семён Факторович рассказывает о том, как руководители команд разработки применяют документацию себе на благо и во вред, и этот доклад доступен в бесплатной трансляции.
Чтобы получить доступ к трансляции, нужно обязательно зарегистрироваться.
В этом году в рамках TeamLeadConf и на той же площадке также проходит KnowledgeConf, конференция об управлении знаниями.
Техническая документация — очевидное подмножество области управления знаниями, поэтому на KnowledgeConf традиционно выступают представители нашего техписательского сообщества.
Отличные новости в том, что организаторы TeamLeadConf решили сделать бесплатную онлайн-трансляцию основного трека, и у всех желающих будет возможность послушать отличные доклады о документации и не только!
30 ноября (в четверг) в 16:20 Мск Семён Факторович рассказывает о том, как руководители команд разработки применяют документацию себе на благо и во вред, и этот доклад доступен в бесплатной трансляции.
Чтобы получить доступ к трансляции, нужно обязательно зарегистрироваться.
🔥11
Спойлеры завтрашнего доклада Семёна Факторовича (30 ноября, 16:20 Мск) на TeamLeadConf 2023.
Напоминаем, что этот доклад, а вместе с ним и много других классных выступлений основного трека конференции доступны в бесплатной онлайн-трансляции.
TeamLeadConf 2023 пройдет 30 ноября и 1 декабря 2023.
Напоминаем, что этот доклад, а вместе с ним и много других классных выступлений основного трека конференции доступны в бесплатной онлайн-трансляции.
TeamLeadConf 2023 пройдет 30 ноября и 1 декабря 2023.
🔥16👍4😍3❤2🤩1
А у нас новая статья в блоге на Хабре:
Регулярные выражения для технических писателей и не только
Нет-нет, это не про те выражения, которые регулярно произносит вслух техписатель, не укладывающийся в дедлайн. Регулярные выражения (regular expressions) — это мощный инструмент замены фрагментов текста, который «из коробки» поддерживается в вашем любимом текстовом редакторе.
(да, мы знаем, что в интернете есть миллион гайдов по регэкспам, но согласитесь, гораздо приятнее прочитать или отправить коллеге-новичку статью, написанную техписателями и для техписателей)
Регулярные выражения для технических писателей и не только
Нет-нет, это не про те выражения, которые регулярно произносит вслух техписатель, не укладывающийся в дедлайн. Регулярные выражения (regular expressions) — это мощный инструмент замены фрагментов текста, который «из коробки» поддерживается в вашем любимом текстовом редакторе.
(да, мы знаем, что в интернете есть миллион гайдов по регэкспам, но согласитесь, гораздо приятнее прочитать или отправить коллеге-новичку статью, написанную техписателями и для техписателей)
Хабр
Регулярные выражения для технических писателей и не только
Однажды мы в documentat.io решили спасти наших техписов от рутинной ручной замены кавычек и написали для них статью про умную автозамену — с использованием регулярных выражений. Теперь решили...
👍21🔥9❤2
Пройдите большой документационный опрос от documentat.io!
Этот опрос адресован техническим писателям и другим IT-специалистам, разрабатывающим документацию (пусть даже и в параллель со своими основными рабочими обязанностями).
Этим опросом мы хотим узнать:
🔹 Кто мы, русскоязычные техписатели? Из каких профессиональных бэкграундов мы пришли в документацию? Мы преимущественно технари или гуманитарии? Каков наш средний возраст?
🔹 Каковы типичные зарплаты техписателей в России? Как они зависят от региона, используемого инструментального стека, индустрии, размера компании? Есть ли в нашей профессии зарплатный разрыв между женщинами и мужчинами?
🔹 Что мы пишем? Какой процент русскоязычных техписателей пишет только по ГОСТ? Как часто нам приходится документировать API?
🔹 Какими инструментами мы пользуемся? Все ли уже переехали на docs-as-code? Все ли отказались от Confluence?
Анализ результатов опроса будет опубликован в телеграм-канале @documentatio_official и в нашем блоге на Хабре.
Обязательно пройдите опрос, даже если вы не техписатель (а, например, разработчик или аналитик) и даже если вы живете не в России (мы попробуем построить зарплатную статистику в крупных русскоязычных иммигрантских хабах типа Грузии или Кипра).
Чуть больше подробностей о формате и длине опроса: https://news.1rj.ru/str/technicalwriters/151647
Сам опрос: https://forms.gle/ry1HbL3twnToVruP9
Этот опрос адресован техническим писателям и другим IT-специалистам, разрабатывающим документацию (пусть даже и в параллель со своими основными рабочими обязанностями).
Этим опросом мы хотим узнать:
🔹 Кто мы, русскоязычные техписатели? Из каких профессиональных бэкграундов мы пришли в документацию? Мы преимущественно технари или гуманитарии? Каков наш средний возраст?
🔹 Каковы типичные зарплаты техписателей в России? Как они зависят от региона, используемого инструментального стека, индустрии, размера компании? Есть ли в нашей профессии зарплатный разрыв между женщинами и мужчинами?
🔹 Что мы пишем? Какой процент русскоязычных техписателей пишет только по ГОСТ? Как часто нам приходится документировать API?
🔹 Какими инструментами мы пользуемся? Все ли уже переехали на docs-as-code? Все ли отказались от Confluence?
Анализ результатов опроса будет опубликован в телеграм-канале @documentatio_official и в нашем блоге на Хабре.
Обязательно пройдите опрос, даже если вы не техписатель (а, например, разработчик или аналитик) и даже если вы живете не в России (мы попробуем построить зарплатную статистику в крупных русскоязычных иммигрантских хабах типа Грузии или Кипра).
Чуть больше подробностей о формате и длине опроса: https://news.1rj.ru/str/technicalwriters/151647
Сам опрос: https://forms.gle/ry1HbL3twnToVruP9
Google Docs
Большой опрос о технической документации и о тех, кто ее разрабатывает
Что это за опрос?
Этот опрос адресован техническим писателям и другим IT-специалистам, которые занимаются созданием технической документации (пусть даже и в параллель со своими основными рабочими активностями) — разработчикам, аналитикам, DevOps-инженерам……
Этот опрос адресован техническим писателям и другим IT-специалистам, которые занимаются созданием технической документации (пусть даже и в параллель со своими основными рабочими активностями) — разработчикам, аналитикам, DevOps-инженерам……
👍25