🎓

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

Информационные технологии
← К списку курсов
Обложка курса Купить за 950 ₽
  • Уроков: 25
  • Сложность: easy
  • Аудитория: 👥 Для кого этот курс Курс предназначен для специалистов, которым нужно создавать, поддерживать и публиковать техническую документацию с использованием современных подходов и инструментов: 📄 Технические писатели (начинающие и опытные) Хотят перейти от Word/Confluence к более гибким и автоматизированным инструментам Нуждаются в понимании Git, CI/CD и автоматической сборки 🧑‍💻 Разработчики Пишут документацию к API, библиотекам, CLI-инструментам Хотят структурировать документацию и встроить её в процесс разработки 🧪 QA и DevOps-инженеры Поддерживают проекты, где документация является частью CI/CD Работают с инфраструктурой и конфигурацией, нуждаются в актуальной документации 🎓 Студенты и начинающие специалисты Хотят получить практический опыт работы с документацией, Markdown, GitHub Строят портфолио и готовятся к работе в IT-компаниях 🏢 Продуктовые и проектные команды Нуждаются в едином стандарте и автоматизации публикации внутренней документации Хотят сократить разрыв между разработкой и документированием 🎯 Если вы хотите, чтобы ваша документация обновлялась вместе с кодом, проходила код-ревью, хранилась в Git и автоматически публиковалась — этот курс для вас.
Информационные технологии Платный
Курс познакомит вас с подходом Docs as Code, который применяют ведущие IT-компании. Практические задания помогут освоить инструменты, применимые в реальных проектах. Научитесь создавать техническую документацию по современным стандартам: с использованием Markdown, Git, CI/CD и автоматической публикации.

📘 О курсе

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, и автоматизируете публикацию.

Требования:

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

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

📄 Желательно:

  • Уверенное владение текстовым редактором (VS Code, Notepad++ и др.)

  • Базовое понимание структуры технической документации (что такое руководство, readme, API-справка)

  • Способность работать с файлами и папками на компьютере

🧑‍💻 Технические навыки (на уровне новичка):

  • Основы Markdown (или готовность быстро изучить)

  • Начальное представление о том, что такое Git и репозиторий (будет объяснено в курсе)

  • Умение пользоваться GitHub или GitLab (или готовность создать аккаунт и попробовать)

💻 Что понадобится во время обучения:

  • Установленный Git

  • Текстовый редактор (например, Visual Studio Code)

  • Учётная запись на GitHub или GitLab

  • Возможность установить Python (для сборки MkDocs)

  • Браузер и стабильный интернет

🟢 Важно: курс рассчитан на новичков в Git и CI/CD. Всё будет разъясняться пошагово, с практикой.