Documentat.io

Что это за курс

Десятки продуктов, проектов и конфигураций? Тысячи страниц контента? Ни дня без обновлений? Публикация в разные форматы? Автоматизируйте разработку, обновление и выпуск технической документации с помощью технологии DITA. Как это сделать — участники вебинара увидят собственными глазами.

Для кого

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

Программа курса

• Нужна ли вам DITA? Какие выгоды приносит эта технология? Как DITA выглядит на фоне аналогичных технологий? Почему DITA не исчерпывается чисто техническими моментами? Какие перспективы у технологии DITA и у вас с ней?

• Основы технологии DITA. Как превратить техническую документацию в конструктор, а главное, зачем? Какими должны быть детали этого конструктора? Как быстро и правильно собирать из этого конструктора нужные документы?

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

• Публикация из DITA в выходные форматы. Что такое DITA Open Toolkit и как с ним работать? Какие форматы поддерживаются? Как настраивают оформление выходных документов? Зачем и как автоматизировать публикацию документов?

• Особые случаи публикации. DITA и ГОСТ: как подружить их друг с другом? Публикация из DITA в Microsoft Word. Публикация в веб-форматы: вики-системы, веб-хелп, системы доставки контента. Встраиваемая техническая документация.

• Интеграция проектов на DITA с другими системами. Импорт контента из Markdown и Microsoft Word. Вставка в документы данных из Microsoft Excel. Вставка в документы иллюстраций на основе графической разметки: GraphViz, PlantUML.

• Внедрение технологии DITA в компании. Проверка целесообразности и обоснование внедрения. Требования к квалификации специалистов. Встраивание DITA в процессы документирования. Ведение библиотеки реюза, использование CCMS.

• Бонус-трек: DITA и искусственный интеллект. Как писать топики с помощью LLM? Как автоматически искать реюз? (Если успеем, и если у слушателей останутся силы.)

Формат курса

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

Для участия в курсе вам потребуется доступ к Zoom и Telegram. Для выполнения практических работ нужно будет установить у себя DITA Open Toolkit и XML-редактор. Необходимые инструкции и ссылки на программное обеспечение будут разосланы слушателям заранее.