Stepik Docs as Code: Пишем тексты как код
О курсе
Подробнее
Цель курса состоит в знакомстве с подходом Docs as Code при написании текстов.
Курс построен на базе кейса, в ходе которого учащийся напишет техническую документацию на HTTP-сервис. Результат может быть использован в качестве проекта в вашем портфолио.
Особенность курса состоит в создании структуры технической документации и написании файлов с исходниками текстов из кейса через консоль с помощью редактора vim или аналогов. Это необходимо для лучшего понимания используемых технологий. Только после завершения этого этапа рекомендуется переходить к использованию специализированных IDE (например, IntelliJ IDEA), позволяющих значительно ускорить процесс работы над текстами.
В курсе будут использованы технологии:
Требования
Что нужно для старта
- опыт работы с *nix системами;
- базовые знания bash;
- понимание технологии git;
- знания английского, достаточные для чтения технической литературы
Результат
Что вы получите
- пользоваться языком текстовой разметки Asciidoc и PlantUml для создания исходников технической документации;
- собирать техническую документацию локально в формате html;
- настраивать автоматическую сборку и размещение технической документации в сети интернет
Навыки
Чему вы научитесь
- Познакомимся с подходом Docs as Code, предлагающим использование инструментов разработчика для написания текстов различной природы от технической документации на приложения, сервисы, цифровые продукты до статей, учебных курсов, блог-постов
Аудитория
Для кого этот курс
- Технические писатели, системные аналитики, разработчики. Все, кто пишет тексты и связан с ИТ
Содержание
4 занятияПрограмма курса
№ТемаЧто внутри
01Учимся писать техническую документацию
- Введение
- Основы языка текстовой разметки Asciidoc
- Основы разработки диаграмм с использованием PlantUml
02Учимся работать с версиями технической документации
- Схемы версионирования
- Основы контроля версий c использованием git
- Знакомство с тегами в git
03Учимся совместной работе над технической документацией
- Отправка технической документации на сервер
- Клонирование удалённого репозитория и внесение изменений
- Проверка изменений и сохранение на удалённом сервере
04Учимся автоматизировать сборку и публиковать в сети интернет
- Сборка и публикация при отправке (push) изменений в main
- Сборка и публикация при сохранении (merge) изменений в main
- Заключение
01Учимся писать техническую документацию
- Введение
- Основы языка текстовой разметки Asciidoc
- Основы разработки диаграмм с использованием PlantUml
02Учимся работать с версиями технической документации
- Схемы версионирования
- Основы контроля версий c использованием git
- Знакомство с тегами в git
03Учимся совместной работе над технической документацией
- Отправка технической документации на сервер
- Клонирование удалённого репозитория и внесение изменений
- Проверка изменений и сохранение на удалённом сервере
04Учимся автоматизировать сборку и публиковать в сети интернет
- Сборка и публикация при отправке (push) изменений в main
- Сборка и публикация при сохранении (merge) изменений в main
- Заключение
Документ после выпуска
Сертификат Stepik
Организатор
Автор курса
Мнения учеников
Отзывы о курсе
Оставьте отзыв
Расскажите о качестве обучения, поддержке и результате. Это поможет другим выбрать организацию осознанно.
Оставьте заявку
Консультант ответит на вопросы о курсе «Docs as Code: Пишем тексты как код» и поможет разобраться в деталях обучения.
Нажимая кнопку, вы даете согласие на обработку персональных данных
Направления:Анализ данных
Информация обновлена 28 июля 2026 г.
Продолжить выбор
Похожие курсы
Начать без затрат
