Это Оксана, ведущая нашего экспресс-курса для технических писателей.
Она совсем недавно завершила работу с октябрьской группой этого курса: прочитала четыре лекции, ответила на сотню вопросов от слушателей, вместе с командой помощников проверила несколько десятков домашних заданий.
И это было здорово!
Как и любой хороший преподаватель, основную часть удовольствия от своей работы Оксана находит в общении с мотивированными и заинтересованными слушателями.
Порадуйте Оксану, приходите на ее ноябрьский курс!
❇️ Экспресс-курс «Технический писатель»: маленький вводный курс для тех, кто пока еще не знаком с профессией. Немного теории, немного практических заданий, краткий обзор профессии и рынка труда. 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
Наш большой документационный опрос прошли уже 330 человек, пройдите его и вы!
Наша оптимистичная цель — 1000 респондентов, будем рады, если вы нам поможете😊
А еще обязательно скиньте ссылку на опрос вашим коллегам и друзьям, которые прикладывают руку к созданию документации: разработчикам, тимлидам, аналитикам...
https://habr.com/ru/companies/documentat/articles/784916/
Наша оптимистичная цель — 1000 респондентов, будем рады, если вы нам поможете😊
А еще обязательно скиньте ссылку на опрос вашим коллегам и друзьям, которые прикладывают руку к созданию документации: разработчикам, тимлидам, аналитикам...
https://habr.com/ru/companies/documentat/articles/784916/
Хабр
Большой опрос о технической документации и о тех, кто ее разрабатывает
По мнению ChatGPT 4, именно так выглядят технические писатели разных стран и эпох Мы ( documentat.io ) решили подробно изучить рынок труда русскоязычных техписателей. Для этого мы создали опрос ,...
🔥11👌2
Наш большой документационный опрос продолжается!
С помощью этого опроса мы исследуем рынок труда технических писателей в России: от медианных зарплат и распределения по индустриям (финтех, телеком, госсектор...) до используемого инструментария и профессиональной мотивации (почему вы любите эту профессию?).
Опрос открыт до 31 января: пожалуйста, пройдите его сами и перешлите его своим коллегам!
Анкета опроса: https://forms.gle/ry1HbL3twnToVruP9
Чуть больше подробностей: https://habr.com/ru/companies/documentat/articles/784916/
С помощью этого опроса мы исследуем рынок труда технических писателей в России: от медианных зарплат и распределения по индустриям (финтех, телеком, госсектор...) до используемого инструментария и профессиональной мотивации (почему вы любите эту профессию?).
Опрос открыт до 31 января: пожалуйста, пройдите его сами и перешлите его своим коллегам!
Анкета опроса: https://forms.gle/ry1HbL3twnToVruP9
Чуть больше подробностей: https://habr.com/ru/companies/documentat/articles/784916/
Google Docs
Большой опрос о технической документации и о тех, кто ее разрабатывает
Что это за опрос?
Этот опрос адресован техническим писателям и другим IT-специалистам, которые занимаются созданием технической документации (пусть даже и в параллель со своими основными рабочими активностями) — разработчикам, аналитикам, DevOps-инженерам……
Этот опрос адресован техническим писателям и другим IT-специалистам, которые занимаются созданием технической документации (пусть даже и в параллель со своими основными рабочими активностями) — разработчикам, аналитикам, DevOps-инженерам……
❤14
А вот и первые курсы 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 января. Пожалуйста, поучаствуйте в нем, чтобы наше профсообщество получило более четкое представление о том, как выглядит современная профессия технического писателя.
❇️ Управляем командой технических писателей: двухдневный семинар для техписателей-тимлидов и тех, кто готовится к этой роли. Масштабирование команды, профессиональный рост подчиненных, делегирование задач, настройка процессов, отбор и наем техписателей. 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 января. Пожалуйста, поучаствуйте в нем, чтобы наше профсообщество получило более четкое представление о том, как выглядит современная профессия технического писателя.
🔥16❤2👌2👨💻2👍1🥰1
Всякие интересные инициативы от наших друзей и знакомых:
🔸Таня Фокина, UX-писатель и автор канала «Таня прочитала», проводит зарплатный опрос русскоязычных UX-писателей. Если вы занимаетесь задачами, связанными с текстами в UI, то поучаствуйте в опросе!
🔸Очередная конференция об управлении знаниями KnowledgeConf пройдет в июне 2024 в Санкт-Петербурге. 1 февраля 2024 оргкомитет конференции собирает онлайн-встречу с потенциальными докладчиками и всеми интересующимися. Участие в KnowledgeConf — отличный способ поделиться с сообществом вашими наработками в области организации баз знаний, ускорения онбординга, настройки процессов документирования и пр.
И не забывайте про наш большой документационный опрос! Он открыт до 31 января.
❤6👍2👨💻1
В конце января мы завершили наш большой документационный опрос.
Огромное спасибо всем, кто уделил ему время!
Мы получили ответы от более чем 500 респондентов. 350 опрошенных идентифицируют себя как техписатели, остальные участники преимущественно относят себя к разработчикам или аналитикам.
Устные интервью, в которых мы предлагали поучаствовать респондентам, помаленьку проводятся (пусть и не так быстро, как хотелось бы) и будут идти как минимум до конца марта.
Желающих пройти устное интервью оказалось невероятно много (более 150), поэтому, к сожалению, мы физически не успеем опросить всех.
Мы выстроили очередь из тех, кто согласился поговорить с нами и помаленьку идем по ней: если очередь дойдет до вас, то мы немедленно вам напишем и назначим время созвона.
А если очередь до вас дойти не успеет и мы с вами не поговорим, то вы поучаствуете в розыгрыше призов наравне с теми, кто прошел устное интервью.
Напоминаю, что среди согласившихся на интервью мы разыграем (на выбор каждого выигравшего) промокод на скидку в 100% на любой курс documentat.io или подарочный сертификат в Ozon/Wildberries или любой другой онлайн-магазин в вашей локации.
Огромное спасибо всем, кто уделил ему время!
Мы получили ответы от более чем 500 респондентов. 350 опрошенных идентифицируют себя как техписатели, остальные участники преимущественно относят себя к разработчикам или аналитикам.
Устные интервью, в которых мы предлагали поучаствовать респондентам, помаленьку проводятся (пусть и не так быстро, как хотелось бы) и будут идти как минимум до конца марта.
Желающих пройти устное интервью оказалось невероятно много (более 150), поэтому, к сожалению, мы физически не успеем опросить всех.
Мы выстроили очередь из тех, кто согласился поговорить с нами и помаленьку идем по ней: если очередь дойдет до вас, то мы немедленно вам напишем и назначим время созвона.
А если очередь до вас дойти не успеет и мы с вами не поговорим, то вы поучаствуете в розыгрыше призов наравне с теми, кто прошел устное интервью.
Напоминаю, что среди согласившихся на интервью мы разыграем (на выбор каждого выигравшего) промокод на скидку в 100% на любой курс documentat.io или подарочный сертификат в Ozon/Wildberries или любой другой онлайн-магазин в вашей локации.
👍33🔥14😍4❤1👨💻1
На Хабре опубликована третья, завершающая статья нашего цикла об англоязычной документации.
На этот раз мы говорим о том, как адресовать свою документацию глобальной, non-native аудитории.
(да, речь в статье идет в том числе о Simplified Technical English и Global English)
Ставьте плюсики и подписывайтесь на наш хабраблог! Итоги нашего большого соцопроса будут опубликованы там уже в этом месяце.
На этот раз мы говорим о том, как адресовать свою документацию глобальной, non-native аудитории.
(да, речь в статье идет в том числе о Simplified Technical English и Global English)
Ставьте плюсики и подписывайтесь на наш хабраблог! Итоги нашего большого соцопроса будут опубликованы там уже в этом месяце.
Хабр
Как улучшить английский в документации. Часть 3: мировая аудитория
Привет, Хабр! Продолжаю делиться с вами опытом написания документации на английском. Напомню о предыдущих сериях: Первая часть — о распространённых грамматических и стилистических сложностях, с...
❤23🔥12🥰2👍1
Опубликовали на Хабре веселую статью о документации, адресованную начинающим IT-специалистам.
Злые нейросети, миграция архитекторов в Амстердам, героические инженеры техподдержки, стендап-комедия в командах разработки — казалось бы, причем тут техническая документация?
А вот!
Злые нейросети, миграция архитекторов в Амстердам, героические инженеры техподдержки, стендап-комедия в командах разработки — казалось бы, причем тут техническая документация?
А вот!
Хабр
Нужно ли писать документацию?
Статья написана по мотивам одноимённого доклада Семёна Факторовича на конференции SnowOne'23 , адресованного студентам IT-специальностей. Если вы не очень любите читать и у вас есть 50 минут...
🔥22❤7👍1🤩1😍1
А у нас новый учебный курс, на этот раз о ревью.
Ревью — не жаргонизм, а устоявшийся термин. В рамках ревью мы вычитываем технические документы, делаем текст более понятным и улучшаем его стилистику, следим за соблюдением стайлгайдов, а также проверяем, что документ не содержит неправды.
Этот курс рассказывает о приемах, процессах и этикете ревью технической документации.
В практической части курса мы проведем ревью фрагмента вашей документации по стандартам documentat.io.
27 мая — 6 июня 2024, онлайн.
Это тестовая группа, в ней всего 10 мест, поэтому успевайте записаться!
https://documentat.io/courses/review/
Ревью — не жаргонизм, а устоявшийся термин. В рамках ревью мы вычитываем технические документы, делаем текст более понятным и улучшаем его стилистику, следим за соблюдением стайлгайдов, а также проверяем, что документ не содержит неправды.
Этот курс рассказывает о приемах, процессах и этикете ревью технической документации.
В практической части курса мы проведем ревью фрагмента вашей документации по стандартам documentat.io.
27 мая — 6 июня 2024, онлайн.
Это тестовая группа, в ней всего 10 мест, поэтому успевайте записаться!
https://documentat.io/courses/review/
documentat.io
Курс «Ревью документации»
Заказная разработка технической документации. Консалтинг по процессам документирования. Курсы для технических писателей.
❤9👍6🔥2
А вот и расписание курсов 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
❇️ Большой курс по ГОСТ. Полное погружение в ГОСТ для тех, кто с ним еще не сталкивался. Расскажем, чем работа по ГОСТ отличается от других техписательских задач. Научим писать и сдавать ГОСТ-комплекты документации. 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-плейлисте или в телеграм-чате курса.
Все курсы проходят онлайн в формате живых вебинаров. Участникам будут доступны видеозаписи и материалы занятий.
❤34👍4🔥4
За выходные мы укомплектовали группы на бóльшую часть только что анонсированных курсов. Спасибо вам за активный интерес к тому, что мы делаем!
Сейчас у нас открыта запись только на эти курсы:
❇️ Ревью документации: методы, приемы, процессы. Поговорим о видах ревью, о процессах вокруг него, об этикете и человеческой стороне проверки качества документации. В практической части курса разберем характерные проблемы технических текстов и проведем ревью вашего фрагмента документации. 27 мая – 6 июня 2024
❇️ Управляем командой технических писателей: семинар для техписателей-тимлидов и тех, кто готовится к этой роли. Масштабирование команды, профессиональный рост подчиненных, делегирование задач, настройка процессов, отбор и наем техписателей. 16–20 сентября 2024.
Если вы ранее оставляли заявки на какие-либо из наших курсов (включая те, на которые набор уже закрыт), наши менеджеры обязательно свяжутся с вами в течение этой недели.
Если на каком-то из укомплектованных курсов освободятся места, мы немедленно анонсируем это в телеграм-канале @documentatio_official.
Сейчас у нас открыта запись только на эти курсы:
❇️ Ревью документации: методы, приемы, процессы. Поговорим о видах ревью, о процессах вокруг него, об этикете и человеческой стороне проверки качества документации. В практической части курса разберем характерные проблемы технических текстов и проведем ревью вашего фрагмента документации. 27 мая – 6 июня 2024
❇️ Управляем командой технических писателей: семинар для техписателей-тимлидов и тех, кто готовится к этой роли. Масштабирование команды, профессиональный рост подчиненных, делегирование задач, настройка процессов, отбор и наем техписателей. 16–20 сентября 2024.
Если вы ранее оставляли заявки на какие-либо из наших курсов (включая те, на которые набор уже закрыт), наши менеджеры обязательно свяжутся с вами в течение этой недели.
Если на каком-то из укомплектованных курсов освободятся места, мы немедленно анонсируем это в телеграм-канале @documentatio_official.
❤7
Наша статья про английский язык победила в номинации «Подготовка технической документации» конкурса «Технотекст 2023»!
Поздравляем автора статьи Костю Макушева!
Поздравляем автора статьи Костю Макушева!
Хабр
Как улучшить английский в документации. Часть 2: ловушки двусмысленности
Привет, Хабр! Я работаю техническим писателем в компании documentat.io , мы занимаемся заказной разработкой технической документации, в том числе на английском языке. В своей первой статье я разобрал,...
🔥50❤7👍7👏6
Помаленьку начинаем публиковать на Хабре результаты большого техписательского опроса, который мы проводили в январе 2024.
Первая статья расскажет об основных, но очень важных срезах русскоязычного сообщества техписателей:
- В каких странах и городах мы живем?
- Сколько нам лет?
- Кого среди нас больше — мужчин или женщин?
- Сколько мы зарабатываем?
https://habr.com/ru/companies/documentat/articles/818199/
Первая статья расскажет об основных, но очень важных срезах русскоязычного сообщества техписателей:
- В каких странах и городах мы живем?
- Сколько нам лет?
- Кого среди нас больше — мужчин или женщин?
- Сколько мы зарабатываем?
https://habr.com/ru/companies/documentat/articles/818199/
Хабр
Результаты большого техписательского опроса. География, демография, зарплаты
C вами Семён Факторович и компания documentat.io . С 2018 года мы помогаем IT-компаниям создавать техническую документацию: пишем документацию на заказ, консультируем инженерные команды по процессам...
🔥33👍16❤7👏1
Публикация зарплатной статистики по результатам нашего опроса подняла в желтом техписательском чате острую, но, в целом, резонную дискуссию:
Не получилось ли так, что авторы опроса (я и documentat.io) планируют использовать эти величины для манипуляции рынком труда и для занижения зарплат в техписательских вакансиях?
В пылу спора я накидал несколько эмоциональных тезисов на эту тему. По прошествию недели я несколько подостыл, но все еще готов подписаться под своими словами, поэтому привожу свое сообщение полной цитатой.
Не получилось ли так, что авторы опроса (я и documentat.io) планируют использовать эти величины для манипуляции рынком труда и для занижения зарплат в техписательских вакансиях?
В пылу спора я накидал несколько эмоциональных тезисов на эту тему. По прошествию недели я несколько подостыл, но все еще готов подписаться под своими словами, поэтому привожу свое сообщение полной цитатой.