Docs as Code: Документация как код для технических писателей

📘 О курсе

Docs as Code: Документация как код для технических писателей — это практико-ориентированный курс, который научит вас создавать и поддерживать техническую документацию по тем же принципам, что и программный код: в Markdown, под контролем версий, с использованием CI/CD и автоматической публикацией.

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

🎯 Цели курса

• Освоить подход Docs as Code — документирование с использованием инструментов разработчиков

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

• Познакомиться с современными инструментами (Markdown, MkDocs, Git, CI/CD, Swagger, Mermaid)

• Подготовить портфолио: сайт документации, опубликованный на GitHub Pages

💡 Почему стоит выбрать этот курс

• Практика от начала до конца: каждый модуль содержит задания с реальными инструментами

• Без лишней теории: вы с первого шага работаете в Markdown, Git и CI

• Подходит новичкам в Git: всё объясняется пошагово

• Подходит опытным: вы автоматизируете документацию, создадите API-референс и настроите публикацию

• Итог — реальный проект: собственный сайт-документации, который можно показать работодателю или внести в портфолио

🧠 После прохождения курса вы сможете:

• Писать техническую документацию в Markdown и организовывать её структуру

• Работать с репозиториями GitHub или GitLab как технический писатель

• Использовать генераторы документации (MkDocs + темы)

• Визуализировать архитектуру и процессы с помощью Mermaid и PlantUML

• Встраивать и публиковать API-документацию (OpenAPI / Swagger)

• Настраивать CI/CD для автоматической сборки и публикации документации

• Разрабатывать и поддерживать сайт-документации как полноценный участник DevOps-команды

🧪 Что вам предстоит делать:

• Писать и структурировать документацию в Markdown

• Работать с Git и репозиториями GitHub

• Настраивать генератор MkDocs и YAML-конфигурацию

• Визуализировать схемы (Mermaid, PlantUML)

• Подключать и отображать OpenAPI YAML

• Настраивать автоматическую публикацию через GitHub Actions

• Выполнить итоговый проект — создать и опубликовать полноценный сайт-документации

📂 Структура курса:

Модуль 1. Введение

• Что такое Docs as Code и зачем он нужен

• Обзор инструментов

Модуль 2. Работа с Markdown

• Базовая и расширенная разметка

• Практика: написание первого руководства

Модуль 3. Git и контроль версий

• Основы Git и GitHub

• Практика: коммиты и ветки

Модуль 4. Генерация сайта документации

• MkDocs и Material for MkDocs

• Конфигурация и структура проекта

Модуль 5. Автоматизация и CI/CD

• Настройка GitHub Actions

• Публикация на GitHub Pages

Модуль 6. Визуализация и API

• Mermaid, PlantUML

• OpenAPI и Swagger

Модуль 7. Итоговый проект

• Создание полноценного сайта документации

• Публикация и защита проекта

🔧 Все задания практические, с ручной или автоматической проверкой. Вы поэтапно создадите документацию, подключите визуализацию и API, и автоматизируете публикацию.