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

12 уроков,

начало 21 ноября

Сложность

Начинающий

Тип обучения

Курс

Формат обучения

Записанные лекции

Сертификат

Да

Стоимость курса

4 500 ₽

нет рассрочки

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

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

Цель курса состоит в знакомстве с подходом Docs as Code при написании текстов.

Курс построен на базе кейса, в ходе которого учащийся напишет техническую документацию на HTTP-сервис. Результат может быть использован в качестве проекта в вашем портфолио.

Особенность курса состоит в создании структуры технической документации и написании файлов с исходниками текстов из кейса через консоль с помощью редактора vim или аналогов. Это необходимо для лучшего понимания используемых технологий. Только после завершения этого этапа рекомендуется переходить к использованию специализированных IDE (например, IntelliJ IDEA), позволяющих значительно ускорить процесс работы над текстами.

Что вы получите после обучения

Приобретаемые навыки

Техническая документация

Asciidoctor

PlantUML

Git

GitHub

IntelliJ IDEA

HTTP сервисы

Вас будут обучать

Алексей Лобзов

курс

MBA, Руководитель направления развития компетенции системного анализа в АО "Альфа-Банк"

Являюсь членом программного комитета конференции по системному и бизнес-анализу Flow от JUG Ru Group, победителем конкурса Sovcombank Challenge 2021 в номинации «Системный анализ» и соавтором программы подготовки системных аналитиков от SkillFactory. tg, habr: @alobzov

Образовательная организация

Stepik

4.6

60 отзывов

Stepik — образовательная платформа и конструктор
онлайн-курсов. Мы разрабатываем алгоритмы адаптивного обучения, сотрудничаем с авторами MOOC, помогаем
в проведении олимпиад и программ переподготовки.
Наша цель — сделать образование открытым и удобным.

Помогаем учиться, а также создавать свои курсы и обучать

Первые учебные материалы были размещены на платформе в 2013 году. Сегодня среди охваченных курсами тем: программирование, информатика, математика, статистика
и анализ данных, биология и биоинформатика, инженерно-технические и естественные науки. Онлайн-курсы, размещенные на Stepik, неоднократно становились призерами конкурсов онлайн-курсов, а система автоматизированной проверки задач используется в ряде курсов на платформах Coursera и edX. Также Stepik активно развивает направление адаптивного обучения, где каждый сможет изучать материал, подобранный индивидуально под свой уровень знаний.

Stepik является также площадкой для проведения конкурсов и олимпиад — среди мероприятий — отборочный этап Олимпиады НТИ, онлайн-этап акции Тотальный диктант, международная олимпиада по биоинформатике.

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

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

Учимся писать техническую документацию
1. Введение
2. Основы языка текстовой разметки Asciidoc
3. Основы разработки диаграмм с использованием PlantUml
Учимся работать с версиями технической документации
1. Схемы версионирования
2. Основы контроля версий c использованием git
3. Знакомство с тегами в git
Учимся совместной работе над технической документацией
1. Отправка технической документации на сервер
2. Клонирование удалённого репозитория и внесение изменений
3. Проверка изменений и сохранение на удалённом сервере
Учимся автоматизировать сборку и публиковать в сети интернет
1. Сборка и публикация при отправке (push) изменений в main
2. Сборка и публикация при сохранении (merge) изменений в main
3. Заключение