Docs as Code: Пишем тексты как код

Курс «Docs as Code» поможет вам понять, как работать с техническими текстами так же эффективно, как разработчики работают с кодом. Это практический путь к современным методам документирования, основанный на реальных инструментах и рабочих процессах.

Что вы узнаете на курсе

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

Docs as Code: суть подхода

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

Практика через консоль

Особый акцент делается на ручное создание структуры документации и написание исходных файлов через консоль с использованием vim или аналогичных редакторов. Это позволит глубоко понять:

• как устроены текстовые форматы;
• каким образом работает сборка документации;
• почему автоматизация в Docs as Code настолько важна.

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

Используемые технологии

• Asciidoctor — основной формат для документации;
• PlantUML — инструмент для диаграмм;
• git и GitHub — хранение, ревью, автоматизация.

Для кого предназначен курс

Курс подходит для тех, кто связан с созданием технических текстов и занимается разработкой или аналитикой:

• технические писатели;
• системные аналитики;
• разработчики;
• все, кому необходимо писать документацию для ИТ‑проектов.

Начальные требования

Для комфортного обучения понадобится базовая техническая подготовка:

• опыт работы с *nix‑системами;
• знание базовых команд bash;
• понимание принципов работы git;
• английский язык на уровне чтения технических текстов.