documentat.io – Telegram
documentat.io
1.05K subscribers
22 photos
2 files
80 links
Разработка технической документации, онлайн-курсы для технических писателей. documentat.io
Download Telegram
Сделали стикерпак для технических писателей от Documentat!

Жмите на ссылку, добавляйте набор и отправляйте стикеры коллегам — пусть рабочая переписка станет немного веселей 🎉
🔥3510👏1
This media is not supported in your browser
VIEW IN TELEGRAM
🔥25😁23💯43👌2
Запись на ноябрьский поток курса «Документация API» открыта!

📅 Когда: 22–30 ноября по субботам и воскресеньям с 11:00 до 14:00 по МСК
📍 Где: онлайн в Zoom-конференции

Не знакомы с API и не представляете, как его документировать, но очень хотите познакомиться и представить? Тогда вам подойдёт этот курс — его материал рассчитан на технических писателей, которые уже имеют опыт разработки документации, но пока не описывали API.

Ведущий курса — Денис Мазин, руководитель команды технических писателей в TradingView.

В программе:
▪️ Введение в API.​ Виды API-документации.
▪️ REST API: особенности, форматы данных.
▪️ Справочники API: спецификация OpenAPI.
▪️ Инструменты для разработки API-документации.
▪️ Публикация API-документации.

Участников курса ждут не только лекции, но и практические задания: вы сможете поэкспериментировать со структурой документационного портала, сделать запросы к API, написать собственные документы в IDE и опубликовать их.

А ещё этот поток — нетипичный: все лекции будут на выходных. Если вы давно хотели больше узнать про документирование API, но не могли совместить курс с работой или сомневались, что вам хватит времени на домашки, приходите сейчас!

📝 Подробнее узнать о программе курса и оставить заявку можно на сайте documentat.io.
👍13🔥83🥰1
⚠️ Внимание, мошенники! ⚠️

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

Пожалуйста, игнорируйте подобные сообщения и сразу жалуйтесь на спам.

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

— Мы не делаем рассылки по личкам о том, что запись открыта.
— Мы не предлагаем оплатить участие в курсах «напрямую».
— Мы не просим передать нам коды подтверждения из SMS.
😱178👍5🤬2🙏1
Продолжается запись на ноябрьский поток курса «Документация API»

Курс пройдёт 22–30 ноября. Он предназначен для опытных технических писателей, которые пока не документировали API, но хотят разобраться в этой теме. На этот раз встречаемся по субботам и воскресеньям с 11:00 до 14:00 по МСК — этот поток особенно подойдёт тем, у кого нет возможности посещать лекции в будние дни.

Курс состоит из теоретической и практической частей: полученные знания можно будет сразу применить на практике и получить подробную обратную связь от преподавателя.

Чтобы подать заявку на участие, заполните форму на странице курса.
👍5🔥2😁1
Открываем запись на новый курс по DITA

📅 Когда: 6–14 декабря по субботам и воскресеньям с 10:00 до 14:00 по МСК
📍 Где: онлайн в Zoom-конференции

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

На курсе разберём:
▪️ как устроена автоматизация документирования;
▪️ из чего состоит технологический стек DITA;
▪️ зачем нужны информационные типы;
▪️ как спроектировать систему сборки документов;
▪️ как внедрить технологию DITA в компании.

Вы научитесь:
▪️ устанавливать инструменты DITA и работать с ними;
▪️ проектировать информационную структуру документации;
▪️ публиковать документы в разных оформлениях и форматах;
▪️ автоматизировать выпуск документов;
▪️ аргументировать внедрение DITA руководству.

К концу прохождения курса вы получите рабочий DITA-проект, который сможете адаптировать под свои задачи.

Бонус-трек — блок про поиск реюза и генерацию статей с помощью ИИ.

Ведущий курса — руководитель разработки профессионального стандарта «Технический писатель» и редактор проекта «Гостопедия» Μuxαuл Oငⲧρогоρငкuǔ.

Стоимость участия — 40 000 рублей.

📝 Подробнее узнать о программе курса и оставить заявку можно на сайте documentat.io.
🔥122👏1😍1💯1
UX без ручной работы: как заставить ИИ самостоятельно писать документацию

Уже в эту пятницу, 28 ноября, Семён Факторович в прямом эфире встретится с автором telegram-канала «Техниндзя» Дмитрием Развозжаевым.

Дмитрий анонсирует свой доклад на мартовской конференции для технических писателей TechWriter Days 3 и расскажет, как с помощью современных ИИ-технологий автоматизировать генерацию пользовательских инструкций на основе интерфейсных макетов из Figma.

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

📅 Когда: 28 ноября в 10:00 по МСК
📍 Где: YouTube и Rutube
🔥3310🎉3
Открываем запись на новый поток экспресс-курса «Технический писатель»!

📅 Когда: с 16 по 25 декабря, по вторникам и четвергам, с 12:00 до 14:00 по МСК
📍 Где: онлайн в Zoom-конференции

Если вы совсем недавно в нашей профессии или только присматриваетесь к ней, у вас наверняка накопился целый ворох вопросов. Кто такие технические писатели и чем они отличаются от аналитиков? В чём разница между инструкцией и руководством пользователя? Когда пора откладывать ГОСТ 34 и браться за ГОСТ 19? Заменит ли нас всех ИИ? Директор ГОСТ-направления Documentat Оксана Гаврюшенко разберёт эти и многие другие темы на нашем курсе для начинающих технических писателей.

На лекциях обсудим:
▪️ Что такое техническая документация и кто такой технический писатель.
▪️ Рынок труда технических писателей.
▪️ Пошаговые инструкции, руководства пользователя и концептуальные статьи.
▪️ ГОСТ 2, ГОСТ 19, ГОСТ 34.
▪️ Основные документы по ГОСТ (обзорно): техническое задание, пояснительная записка, руководство пользователя, программа и методика испытаний.
▪️ Гиды по стилю.
▪️ Ревью технической документации.

В курсе появились новые блоки: начиная с этого потока будем рассказывать об инструментах автоматизации и использовании ИИ в работе технического писателя. Добавилось и новое практическое задание: участники попробуют свои силы в работе с АИС ГОСТ-ON — платформой, предназначенной для генерации ГОСТ-документации из единого источника.

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

И ещё одна новость: это последний поток экспресс-курса «Технический писатель» в привычном формате — со следующего года участники станут получать лекции в записи, а вебинары будут полностью посвящены разбору практических заданий. Так что если вам по душе олдскульные живые лекции, обязательно приходите в декабре!

Стоимость участия — 15 000 рублей.

Подробнее почитать о программе курса и оставить заявку на участие можно на сайте documentat.io.
11🎉3
Запись на курс Advanced Technical Writing уже открыта!

📅 Когда: 19–30 января с 12:00 до 14:30 по МСК
📍 Где: онлайн в Zoom-конференции

Открываем запись на продвинутый курс для технических писателей, который читает Семён Факторович. Курс предназначен для специалистов, которым по роду деятельности нужно описывать сложные программные (и вообще технические) системы, — и в первую очередь для техписателей с 1–2 годами опыта.

В программе курса:
▪️ Жизненные циклы и краеугольные камни технического документа.
▪️ Заочное профилирование целевой аудитории.
▪️ Ревью документов и его виды. Объективные и субъективные критерии качества технического документа. Разрешение неконструктивных споров в процессе ревью.
▪️ Типичные сценарии чтения технического текста. Создание документации с опорой на ожидаемые сценарии её чтения. Подходы к структурированию текста и к подаче информации.
▪️ Типичные ошибки структурирования и подачи информации.
▪️ Роль старшего технического писателя в команде. Создание культуры ревью, передача опыта, формирование командного вкуса.

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

Стоимость участия — 40 000 рублей.

📝 Подробнее узнать о программе и оставить заявку можно на сайте documentat.io.
👍12🔥64
Всем привет! Ровно через полчаса заходите в трансляцию на YouTube или Rutube: Дмитрий Развозжаев и Семён Факторович обсудят в прямом эфире, как с помощью ИИ создавать пользовательские инструкции на основе макетов из Figma.
14🔥4👍3
Открыта запись на курс «Ревью документации: методы, приемы, процессы»

📅 Когда: 2–12 февраля по понедельникам и четвергам с 10:00 до 13:00 по МСК
📍 Где: онлайн в Zoom-конференции

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

Курс по ревью поможет разобраться, как организовать процессы ревью в команде технических писателей и проводить вычитку качественно и корректно. Ведущая курса — Ната Мелихова, главный редактор Documentat.

В программе курса:

▪️ Критерии оценки качества технической документации.
▪️ Виды ревью. Методика проведения ревью: алгоритмы, подводные камни, ключевые моменты.
▪️ Культура ревью: типичные проблемы, с которыми сталкиваются ревьюер и автор документа, и способы их решения.
▪️ Типичные виды ошибок в технической документации.
▪️ Ревью как рабочий процесс: регламенты, хорошие и плохие практики.

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

Стоимость участия — 40 000 рублей.

📝 Подробнее узнать о программе курса и оставить заявку можно на сайте documentat.io.
🔥13
Наш информационный партнёр WriteConf ищет спикеров!

26 февраля 2026 года в Москве пройдёт WriteConf’26 — конференция от создателей «Стачки» для технических писателей, UX-редакторов и работающих с контентом маркетологов.

В программе конференции:

— прикладные кейсы из IT;
— актуальные стратегии для коммуникаций и контента;
— эффективные подходы к разработке технической документации;
— новые решения для SMM и маркетинга;
— лекции от спикеров с реальным опытом.

Программный комитет WriteConf принимает темы докладов до 15 декабря.

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

Формат выступления — 40 минут на доклад и ещё 10 минут на вопросы от слушателей.

Спикеры получат:
— билеты на конференцию (один для себя и один для друга);
— приглашение на beerparty с нетворкингом;
— записи всех докладов;
— фирменный мерч конференции.

Мы тоже планируем заглянуть на WriteConf — приходите послушать наших докладчиков или рассказать о своём профессиональном опыте!
👍4
Открыта запись на новый курс «Документирование архитектуры ИТ-решений»

📅 Когда: 16–20 февраля с 10:00 до 14:00 по МСК
📍 Где: онлайн в Zoom-конференции

Архитектурная документация выражает основу любого ИТ-решения и адресована ключевым участникам проекта: архитекторам, техлидам, сеньорам. От того, как она будет написана, во многом зависит успех проекта или продукта. Специалист, который умеет качественно документировать архитектуру, высоко ценится в любой компании.

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

Курс читает Μuxαuл Oငⲧρогоρငкuǔ — руководитель разработки профессионального стандарта «Технический писатель», редактор проекта «Гостопедия».

В программе курса:

▪️ Определение архитектуры. Архитектурные уровни. Адресаты архитектурной документации и их потребности. Цели, задачи, критерии качества архитектурной документации.
▪️ Основные архитектурные подходы, паттерны и компромиссы. Монолитные, микросервисные и агентские архитектуры. Паттерны. Особенности архитектуры высоконагруженных систем, CAP-теорема.
▪️ Архитектурные решения и приемы их описания. Основные стандарты и фреймворки (ISO 42010, TOGAF ADM) и виды архитектурных документов (Architecture Vision, Architecture Definition Document и другие). Отражение архитектуры в документации по ГОСТ. Главные графические нотации (ArchiMate, BPMN, C4, UML) для разных архитектурных уровней. Составление понятных схем и графических иллюстраций вне стандартных графических языков.
▪️ Формирование технологического стека для ведения архитектурной документации.
▪️ Архитектурная документация как основа для документации в других контурах. Легализация разрыва между архитектурами “as is” и “to be” с помощью роадмапа. Интеграция архитектурной документации с кодом и другими артефактами разработки.

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

Стоимость участия — 50 000 рублей.

📝 Подробнее узнать о программе курса и оставить заявку можно на сайте documentat.io.
🔥93
Профессиональное выгорание: поучительная история одного технического писателя

Если чувствуете, что под конец года справляться с рабочими задачами стало тяжеловато, 30 декабря приходите посмотреть наш прямой эфир — Оксана Гаврюшенко проведёт его вместе с Анастасией Дмитриевой, руководителем отдела документирования компании «Актив». Анастасия анонсирует свой доклад для конференции TechWriter Days 3, посвященный профессиональному выгоранию у технических писателей.

В прямом эфире обсудим:
— какие особенности нашей работы усиливают риск выгорания;
— какая атмосфера в команде способствует выгоранию;
— какие методы самопомощи работают, если вы уже столкнулись с выгоранием.

📅 Когда: 30 декабря в 15:00 по МСК
📍 Где: YouTube, Rutube и ВКонтакте
🔥278👌6