Скоро! Docs as Code: Пишем тексты как код [Stepik]

[SHAREWOOD]

Docs as Code: Текстовая работа в стиле программирования [Stepik]

Откроем для вас принцип Docs as Code, предложив использовать инструментарий программиста для создания текстов - от техдокументации по приложениям, сервисам и цифровым продуктам до статей, учебных материалов и блог-постов.

Что вы освоите

• работу с языками разметки Asciidoc и PlantUml для формирования исходников технической документации;
• локальную компиляцию технической документации в формат html;
• наладку автоматической компиляции и публикации технической документации в интернете.

Об этом курсе

Миссия курса заключается в ознакомлении с методикой Docs as Code в контексте создания текстов.

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

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

В рамках курса мы будем использовать следующие технологии: Asciidoctor, PlantUML, git, GitHub.

Целевая аудитория курса
Технические писатели, системные аналитики, программисты. Все, кто работает с текстами и связан с ИТ-сферой

Спойлер: Содержание курса
Мастерим техническую документацию

1. Введение и демонстрационный доступ
2. Основы разметочного языка Asciidoc
3. Основы построения диаграмм при помощи PlantUml

Разбираемся в версионности технической документации

1. Схематика версионирования
2. Основы контроля версий с использованием git
3. Знакомство с тегированием в git

Обучаемся командной работе над технической документацией

1. Отправка технической документации на сервер
2. Клонирование удаленного репозитория и внесение корректировок
3. Проверка изменений и сохранение на удаленном сервере

Учимся автоматизировать компиляцию и публикацию в интернете

1. Сборка и публикация при отправке (push) изменений в main
2. Сборка и публикация при интеграции (merge) изменений в main
3. Завершающий этап

Скрытая ссылка

»

Материал «Docs as Code: Пишем тексты как код [Stepik]», возможно, скоро появится на SHAREWOOD.

Воспользуйтесь поиском, может быть, он уже опубликован.